vy commented on code in PR #3681:
URL: https://github.com/apache/logging-log4j2/pull/3681#discussion_r2112119708
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -53,13 +58,43 @@ public final class InternalLoggerRegistry {
new WeakHashMap<>();
private final ReadWriteLock lock = new ReentrantReadWriteLock();
-
private final Lock readLock = lock.readLock();
-
private final Lock writeLock = lock.writeLock();
+ // ReferenceQueue to track stale WeakReferences
+ private final ReferenceQueue<Logger> staleLoggerRefs = new
ReferenceQueue<>();
+
public InternalLoggerRegistry() {}
+ /**
+ * Expunges stale entries for logger references and message factories.
+ */
+ private void expungeStaleEntries() {
+ Reference<? extends Logger> loggerRef = staleLoggerRefs.poll();
Review Comment:
```suggestion
final Reference<? extends Logger> loggerRef = staleLoggerRefs.poll();
```
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -53,13 +58,43 @@ public final class InternalLoggerRegistry {
new WeakHashMap<>();
private final ReadWriteLock lock = new ReentrantReadWriteLock();
-
private final Lock readLock = lock.readLock();
-
private final Lock writeLock = lock.writeLock();
+ // ReferenceQueue to track stale WeakReferences
+ private final ReferenceQueue<Logger> staleLoggerRefs = new
ReferenceQueue<>();
+
public InternalLoggerRegistry() {}
+ /**
+ * Expunges stale entries for logger references and message factories.
+ */
+ private void expungeStaleEntries() {
+ Reference<? extends Logger> loggerRef = staleLoggerRefs.poll();
+
+ if (loggerRef != null) {
+ writeLock.lock();
+ try {
+ while (staleLoggerRefs.poll() != null) {
+ // Clear refQueue
+ }
+
+ Iterator<Map.Entry<MessageFactory, Map<String,
WeakReference<Logger>>>> outerIt =
+ loggerRefByNameByMessageFactory.entrySet().iterator();
+ while (outerIt.hasNext()) {
+ Map.Entry<MessageFactory, Map<String,
WeakReference<Logger>>> outerEntry = outerIt.next();
+ Map<String, WeakReference<Logger>> innerMap =
outerEntry.getValue();
+ innerMap.values().removeIf(weakRef -> weakRef.get() ==
null);
+ if (innerMap.isEmpty()) {
+ outerIt.remove();
+ }
+ }
Review Comment:
Could you use naming that is coherent with the origin, please?
1. `outerIt` -> `loggerRefByNameByMessageFactoryEntryIt`
2. `outerEntry` -> `loggerRefByNameByMessageFactoryEntry`
3. `innerMap` -> `loggerRefByName`
4. Use `final` modifiers wherever applicable
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -70,6 +105,8 @@ public InternalLoggerRegistry() {}
public @Nullable Logger getLogger(final String name, final MessageFactory
messageFactory) {
requireNonNull(name, "name");
requireNonNull(messageFactory, "messageFactory");
+ expungeStaleEntries(); // Clean up before retrieving
Review Comment:
```suggestion
expungeStaleEntries();
```
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
Review Comment:
Can you use `final` modifier for variables wherever applicable, please?
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
@@ -0,0 +1,189 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.core.util.internal;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Field;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.message.MessageFactory;
+import org.apache.logging.log4j.message.SimpleMessageFactory;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+class InternalLoggerRegistryTest {
+ private LoggerContext loggerContext;
+ private InternalLoggerRegistry registry;
+ private MessageFactory messageFactory;
+
+ @BeforeEach
+ void setUp(TestInfo testInfo) throws NoSuchFieldException,
IllegalAccessException {
+ loggerContext = new LoggerContext(testInfo.getDisplayName());
+ Field registryField =
loggerContext.getClass().getDeclaredField("loggerRegistry");
+ registryField.setAccessible(true);
+ registry = (InternalLoggerRegistry) registryField.get(loggerContext);
+ messageFactory = SimpleMessageFactory.INSTANCE;
+ }
+
+ @AfterEach
+ void tearDown() {
+ if (loggerContext != null) {
+ loggerContext.stop();
+ }
+ }
+
+ @Test
+ void testGetLoggerReturnsNullForNonExistentLogger() {
+ assertNull(registry.getLogger("nonExistent", messageFactory));
+ }
+
+ @Test
+ void testComputeIfAbsentCreatesLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertNotNull(logger);
+ assertEquals("testLogger", logger.getName());
+ }
+
+ @Test
+ void testGetLoggerRetrievesExistingLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertSame(logger, registry.getLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testHasLoggerReturnsCorrectStatus() {
+ assertFalse(registry.hasLogger("testLogger", messageFactory));
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertTrue(registry.hasLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testExpungeStaleWeakReferenceEntries() {
+ String loggerNamePrefix = "testLogger_";
+ int numberOfLoggers = 1000;
+
+ for (int i = 0; i < numberOfLoggers; i++) {
+ Logger logger = registry.computeIfAbsent(
+ loggerNamePrefix + i,
+ messageFactory,
+ (name, factory) -> new MockLogger(loggerContext, name,
factory));
+ logger.info("Using logger {}", logger.getName());
+ }
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
Review Comment:
Don't use this deprecated-for-removal method, please.
```suggestion
```
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
@@ -0,0 +1,189 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.core.util.internal;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Field;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.message.MessageFactory;
+import org.apache.logging.log4j.message.SimpleMessageFactory;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+class InternalLoggerRegistryTest {
+ private LoggerContext loggerContext;
+ private InternalLoggerRegistry registry;
+ private MessageFactory messageFactory;
+
+ @BeforeEach
+ void setUp(TestInfo testInfo) throws NoSuchFieldException,
IllegalAccessException {
+ loggerContext = new LoggerContext(testInfo.getDisplayName());
+ Field registryField =
loggerContext.getClass().getDeclaredField("loggerRegistry");
+ registryField.setAccessible(true);
+ registry = (InternalLoggerRegistry) registryField.get(loggerContext);
+ messageFactory = SimpleMessageFactory.INSTANCE;
+ }
+
+ @AfterEach
+ void tearDown() {
+ if (loggerContext != null) {
+ loggerContext.stop();
+ }
+ }
+
+ @Test
+ void testGetLoggerReturnsNullForNonExistentLogger() {
+ assertNull(registry.getLogger("nonExistent", messageFactory));
+ }
+
+ @Test
+ void testComputeIfAbsentCreatesLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertNotNull(logger);
+ assertEquals("testLogger", logger.getName());
+ }
+
+ @Test
+ void testGetLoggerRetrievesExistingLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertSame(logger, registry.getLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testHasLoggerReturnsCorrectStatus() {
+ assertFalse(registry.hasLogger("testLogger", messageFactory));
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertTrue(registry.hasLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testExpungeStaleWeakReferenceEntries() {
+ String loggerNamePrefix = "testLogger_";
+ int numberOfLoggers = 1000;
+
+ for (int i = 0; i < numberOfLoggers; i++) {
+ Logger logger = registry.computeIfAbsent(
+ loggerNamePrefix + i,
+ messageFactory,
+ (name, factory) -> new MockLogger(loggerContext, name,
factory));
+ logger.info("Using logger {}", logger.getName());
+ }
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.computeIfAbsent(
+ "triggerExpunge", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ Map<String, WeakReference<Logger>> loggerRefByName =
loggerRefByNameByMessageFactory.get(messageFactory);
+
+ boolean isExpungeStaleEntries = true;
+ for (int i = 0; i < numberOfLoggers; i++) {
+ if (loggerRefByName.containsKey(loggerNamePrefix + i)) {
+ isExpungeStaleEntries = false;
+ break;
+ }
+ }
+ assertTrue(
+ isExpungeStaleEntries,
+ "Stale WeakReference entries were not removed from the
inner map for MessageFactory");
+ });
+ }
+
+ @Test
+ void testExpungeStaleMessageFactoryEntry() {
+ SimpleMessageFactory mockMessageFactory = new SimpleMessageFactory();
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", mockMessageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ logger.info("Using logger {}", logger.getName());
+ logger = null;
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.getLogger("triggerExpunge", mockMessageFactory);
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ assertNull(
+ loggerRefByNameByMessageFactory.get(mockMessageFactory),
+ "Stale MessageFactory entry was not removed from the outer
map");
+ });
+ }
+
+ @Test
+ void testConcurrentAccess() throws InterruptedException {
+ int threadCount = 10;
+ ExecutorService executor = Executors.newFixedThreadPool(threadCount);
+ CountDownLatch latch = new CountDownLatch(threadCount);
+
+ for (int i = 0; i < threadCount; i++) {
+ executor.submit(() -> {
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ latch.countDown();
+ });
+ }
+
+ latch.await();
+ executor.shutdown();
+
+ // Verify logger was created and is accessible after concurrent
creation
+ assertNotNull(
+ registry.getLogger("testLogger", messageFactory),
+ "Logger should be accessible after concurrent creation");
+ }
+
+ private Map<MessageFactory, Map<String, WeakReference<Logger>>>
reflectAndGetLoggerMapFromRegistry()
+ throws NoSuchFieldException, IllegalAccessException {
+ Field loggerMapField =
registry.getClass().getDeclaredField("loggerRefByNameByMessageFactory");
+ loggerMapField.setAccessible(true);
+ @SuppressWarnings("unchecked")
+ Map<MessageFactory, Map<String, WeakReference<Logger>>> loggerMap =
+ (Map<MessageFactory, Map<String, WeakReference<Logger>>>)
loggerMapField.get(registry);
+ return loggerMap;
+ }
+
+ private class MockLogger extends Logger {
Review Comment:
I don't think you really need this definition. All your `new
MockLogger(...)` calls can be replaced with `new Logger(...) {}` instead.
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -147,6 +188,8 @@ public Logger computeIfAbsent(
requireNonNull(messageFactory, "messageFactory");
requireNonNull(loggerSupplier, "loggerSupplier");
+ expungeStaleEntries(); // Clean up before adding a new logger
Review Comment:
```suggestion
// Skipping `expungeStaleEntries()`, it will be invoked by the
`getLogger()` invocation below
```
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -127,6 +166,8 @@ public boolean hasLogger(final String name, final
MessageFactory messageFactory)
public boolean hasLogger(final String name, final Class<? extends
MessageFactory> messageFactoryClass) {
requireNonNull(name, "name");
requireNonNull(messageFactoryClass, "messageFactoryClass");
+ expungeStaleEntries(); // Clean up before checking
Review Comment:
```suggestion
expungeStaleEntries();
```
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
@@ -0,0 +1,189 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.core.util.internal;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Field;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.message.MessageFactory;
+import org.apache.logging.log4j.message.SimpleMessageFactory;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+class InternalLoggerRegistryTest {
+ private LoggerContext loggerContext;
+ private InternalLoggerRegistry registry;
+ private MessageFactory messageFactory;
+
+ @BeforeEach
+ void setUp(TestInfo testInfo) throws NoSuchFieldException,
IllegalAccessException {
+ loggerContext = new LoggerContext(testInfo.getDisplayName());
+ Field registryField =
loggerContext.getClass().getDeclaredField("loggerRegistry");
+ registryField.setAccessible(true);
+ registry = (InternalLoggerRegistry) registryField.get(loggerContext);
+ messageFactory = SimpleMessageFactory.INSTANCE;
+ }
+
+ @AfterEach
+ void tearDown() {
+ if (loggerContext != null) {
+ loggerContext.stop();
+ }
+ }
+
+ @Test
+ void testGetLoggerReturnsNullForNonExistentLogger() {
+ assertNull(registry.getLogger("nonExistent", messageFactory));
+ }
+
+ @Test
+ void testComputeIfAbsentCreatesLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertNotNull(logger);
+ assertEquals("testLogger", logger.getName());
+ }
+
+ @Test
+ void testGetLoggerRetrievesExistingLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertSame(logger, registry.getLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testHasLoggerReturnsCorrectStatus() {
+ assertFalse(registry.hasLogger("testLogger", messageFactory));
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertTrue(registry.hasLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testExpungeStaleWeakReferenceEntries() {
+ String loggerNamePrefix = "testLogger_";
+ int numberOfLoggers = 1000;
+
+ for (int i = 0; i < numberOfLoggers; i++) {
+ Logger logger = registry.computeIfAbsent(
+ loggerNamePrefix + i,
+ messageFactory,
+ (name, factory) -> new MockLogger(loggerContext, name,
factory));
+ logger.info("Using logger {}", logger.getName());
+ }
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.computeIfAbsent(
+ "triggerExpunge", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ Map<String, WeakReference<Logger>> loggerRefByName =
loggerRefByNameByMessageFactory.get(messageFactory);
+
+ boolean isExpungeStaleEntries = true;
+ for (int i = 0; i < numberOfLoggers; i++) {
+ if (loggerRefByName.containsKey(loggerNamePrefix + i)) {
+ isExpungeStaleEntries = false;
+ break;
+ }
+ }
+ assertTrue(
+ isExpungeStaleEntries,
+ "Stale WeakReference entries were not removed from the
inner map for MessageFactory");
Review Comment:
Instead of this, could you _count_ the number of unexpected logger entries
and assert that they are equal to zero, and if not, report how many are found,
please?
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java:
##########
@@ -87,6 +124,8 @@ public InternalLoggerRegistry() {}
}
public Collection<Logger> getLoggers() {
+ expungeStaleEntries(); // Clean up before retrieving
Review Comment:
```suggestion
expungeStaleEntries();
```
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
@@ -0,0 +1,189 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.core.util.internal;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Field;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.message.MessageFactory;
+import org.apache.logging.log4j.message.SimpleMessageFactory;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+class InternalLoggerRegistryTest {
+ private LoggerContext loggerContext;
+ private InternalLoggerRegistry registry;
+ private MessageFactory messageFactory;
+
+ @BeforeEach
+ void setUp(TestInfo testInfo) throws NoSuchFieldException,
IllegalAccessException {
+ loggerContext = new LoggerContext(testInfo.getDisplayName());
+ Field registryField =
loggerContext.getClass().getDeclaredField("loggerRegistry");
+ registryField.setAccessible(true);
+ registry = (InternalLoggerRegistry) registryField.get(loggerContext);
+ messageFactory = SimpleMessageFactory.INSTANCE;
+ }
+
+ @AfterEach
+ void tearDown() {
+ if (loggerContext != null) {
+ loggerContext.stop();
+ }
+ }
+
+ @Test
+ void testGetLoggerReturnsNullForNonExistentLogger() {
+ assertNull(registry.getLogger("nonExistent", messageFactory));
+ }
+
+ @Test
+ void testComputeIfAbsentCreatesLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertNotNull(logger);
+ assertEquals("testLogger", logger.getName());
+ }
+
+ @Test
+ void testGetLoggerRetrievesExistingLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertSame(logger, registry.getLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testHasLoggerReturnsCorrectStatus() {
+ assertFalse(registry.hasLogger("testLogger", messageFactory));
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertTrue(registry.hasLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testExpungeStaleWeakReferenceEntries() {
+ String loggerNamePrefix = "testLogger_";
+ int numberOfLoggers = 1000;
+
+ for (int i = 0; i < numberOfLoggers; i++) {
+ Logger logger = registry.computeIfAbsent(
+ loggerNamePrefix + i,
+ messageFactory,
+ (name, factory) -> new MockLogger(loggerContext, name,
factory));
+ logger.info("Using logger {}", logger.getName());
+ }
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.computeIfAbsent(
+ "triggerExpunge", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ Map<String, WeakReference<Logger>> loggerRefByName =
loggerRefByNameByMessageFactory.get(messageFactory);
+
+ boolean isExpungeStaleEntries = true;
+ for (int i = 0; i < numberOfLoggers; i++) {
+ if (loggerRefByName.containsKey(loggerNamePrefix + i)) {
+ isExpungeStaleEntries = false;
+ break;
+ }
+ }
+ assertTrue(
+ isExpungeStaleEntries,
+ "Stale WeakReference entries were not removed from the
inner map for MessageFactory");
+ });
+ }
+
+ @Test
+ void testExpungeStaleMessageFactoryEntry() {
+ SimpleMessageFactory mockMessageFactory = new SimpleMessageFactory();
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", mockMessageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ logger.info("Using logger {}", logger.getName());
+ logger = null;
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
Review Comment:
```suggestion
```
##########
log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistryTest.java:
##########
@@ -0,0 +1,189 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.core.util.internal;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.awaitility.Awaitility.await;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Field;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.message.MessageFactory;
+import org.apache.logging.log4j.message.SimpleMessageFactory;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+class InternalLoggerRegistryTest {
+ private LoggerContext loggerContext;
+ private InternalLoggerRegistry registry;
+ private MessageFactory messageFactory;
+
+ @BeforeEach
+ void setUp(TestInfo testInfo) throws NoSuchFieldException,
IllegalAccessException {
+ loggerContext = new LoggerContext(testInfo.getDisplayName());
+ Field registryField =
loggerContext.getClass().getDeclaredField("loggerRegistry");
+ registryField.setAccessible(true);
+ registry = (InternalLoggerRegistry) registryField.get(loggerContext);
+ messageFactory = SimpleMessageFactory.INSTANCE;
+ }
+
+ @AfterEach
+ void tearDown() {
+ if (loggerContext != null) {
+ loggerContext.stop();
+ }
+ }
+
+ @Test
+ void testGetLoggerReturnsNullForNonExistentLogger() {
+ assertNull(registry.getLogger("nonExistent", messageFactory));
+ }
+
+ @Test
+ void testComputeIfAbsentCreatesLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertNotNull(logger);
+ assertEquals("testLogger", logger.getName());
+ }
+
+ @Test
+ void testGetLoggerRetrievesExistingLogger() {
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertSame(logger, registry.getLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testHasLoggerReturnsCorrectStatus() {
+ assertFalse(registry.hasLogger("testLogger", messageFactory));
+ registry.computeIfAbsent(
+ "testLogger", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ assertTrue(registry.hasLogger("testLogger", messageFactory));
+ }
+
+ @Test
+ void testExpungeStaleWeakReferenceEntries() {
+ String loggerNamePrefix = "testLogger_";
+ int numberOfLoggers = 1000;
+
+ for (int i = 0; i < numberOfLoggers; i++) {
+ Logger logger = registry.computeIfAbsent(
+ loggerNamePrefix + i,
+ messageFactory,
+ (name, factory) -> new MockLogger(loggerContext, name,
factory));
+ logger.info("Using logger {}", logger.getName());
+ }
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.computeIfAbsent(
+ "triggerExpunge", messageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ Map<String, WeakReference<Logger>> loggerRefByName =
loggerRefByNameByMessageFactory.get(messageFactory);
+
+ boolean isExpungeStaleEntries = true;
+ for (int i = 0; i < numberOfLoggers; i++) {
+ if (loggerRefByName.containsKey(loggerNamePrefix + i)) {
+ isExpungeStaleEntries = false;
+ break;
+ }
+ }
+ assertTrue(
+ isExpungeStaleEntries,
+ "Stale WeakReference entries were not removed from the
inner map for MessageFactory");
+ });
+ }
+
+ @Test
+ void testExpungeStaleMessageFactoryEntry() {
+ SimpleMessageFactory mockMessageFactory = new SimpleMessageFactory();
+ Logger logger = registry.computeIfAbsent(
+ "testLogger", mockMessageFactory, (name, factory) -> new
MockLogger(loggerContext, name, factory));
+ logger.info("Using logger {}", logger.getName());
+ logger = null;
+
+ await().atMost(10, SECONDS).pollInterval(100,
MILLISECONDS).untilAsserted(() -> {
+ System.gc();
+ System.runFinalization();
+ registry.getLogger("triggerExpunge", mockMessageFactory);
+
+ Map<MessageFactory, Map<String, WeakReference<Logger>>>
loggerRefByNameByMessageFactory =
+ reflectAndGetLoggerMapFromRegistry();
+ assertNull(
+ loggerRefByNameByMessageFactory.get(mockMessageFactory),
+ "Stale MessageFactory entry was not removed from the outer
map");
+ });
+ }
+
+ @Test
+ void testConcurrentAccess() throws InterruptedException {
Review Comment:
@jhl221123, @ppkarwasz, do we have a inspiration source (scenario, bug
report, etc.) for this particular test?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@logging.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
