Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implement faster ThreadContextMap #2330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 12, 2024
Merged

Implement faster ThreadContextMap #2330

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3910b7
Creating faster ThreadContextMap based on a String[] in the ThreadLocal
jengebr Feb 28, 2024
6799fa4
Merge branch 'apache:2.x' into StringArrayThreadContextMap
jengebr Feb 29, 2024
6e414b1
Replacing lost finals
jengebr Feb 29, 2024
813b652
Performance bug fix w/ test
jengebr Feb 29, 2024
e612ff2
Fixing javadoc syntax error
jengebr Mar 1, 2024
af98412
Updated per comments on PR
jengebr Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Updated per comments on PR
  • Loading branch information
@jengebr
jengebr committed Mar 8, 2024
commit af98412b785cb2e023787b90109843b589a47100
110 changes: 66 additions & 44 deletions .../spi/StringArrayThreadContextMapTest.java → .../map/StringArrayThreadContextMapTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.logging.log4j.spi;
package org.apache.logging.log4j.internal.map;

import static org.junit.Assert.assertNull;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import org.apache.logging.log4j.test.junit.InitializesThreadContext;
import org.apache.logging.log4j.test.junit.SetTestProperty;
import java.util.Set;
import org.apache.logging.log4j.test.junit.UsingThreadContextMap;
import org.apache.logging.log4j.util.TriConsumer;
import org.junit.jupiter.api.Test;
import org.junitpioneer.jupiter.ClearSystemProperty;

/**
* Tests the {@code StringArrayThreadContextMap} class.
Expand Down Expand Up @@ -56,27 +56,20 @@ public void testHashCodeVsSameKind() {
@Test
public void testGet() {
final StringArrayThreadContextMap map1 = createMap();
assertEquals(null, map1.get("test"));
assertNull(map1.get("test"));
map1.put("test", "test");
assertEquals("test", map1.get("test"));
assertEquals(null, map1.get("not_present"));
}

@Test
public void testDoesNothingIfConstructedWithUseMapIsFalse() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(false);
assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
map.put("key", "value");
assertNull(map1.get("not_present"));
assertEquals("test", map1.getValue("test"));
assertNull(map1.getValue("not_present"));

assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
assertNull(map.get("key"));
map1.clear();
assertNull(map1.get("not_present"));
}

@Test
public void testPut() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
map.put("key", "value");
Expand All @@ -88,7 +81,7 @@ public void testPut() {

@Test
public void testPutAll() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
final int mapSize = 10;
Expand All @@ -106,7 +99,7 @@ public void testPutAll() {

/**
* Test method for
* {@link org.apache.logging.log4j.spi.StringArrayThreadContextMap#remove(java.lang.String)}
* {@link org.apache.logging.log4j.internal.map.StringArrayThreadContextMap#remove(java.lang.String)}
* .
*/
@Test
Expand All @@ -118,6 +111,9 @@ public void testRemove() {
map.remove("key");
assertFalse(map.containsKey("key"));
assertEquals("value2", map.get("key2"));

map.clear();
map.remove("test");
}

@Test
Expand All @@ -132,6 +128,9 @@ public void testRemoveAll() {
map.removeAll(newValues.keySet());

map.put("3", "value3");

map.clear();
map.removeAll(newValues.keySet());
}

@Test
Expand All @@ -148,7 +147,7 @@ public void testClear() {
* @return
*/
private StringArrayThreadContextMap createMap() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertTrue(map.isEmpty());
map.put("key", "value");
map.put("key2", "value2");
Expand All @@ -159,7 +158,7 @@ private StringArrayThreadContextMap createMap() {

@Test
public void testGetCopyReturnsMutableMap() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertTrue(map.isEmpty());
final Map<String, String> copy = map.getCopy();
assertTrue(copy.isEmpty());
Expand All @@ -173,7 +172,7 @@ public void testGetCopyReturnsMutableMap() {

@Test
public void testGetCopyReturnsMutableCopy() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
map.put("key1", "value1");
assertFalse(map.isEmpty());
final Map<String, String> copy = map.getCopy();
Expand All @@ -194,14 +193,14 @@ public void testGetCopyReturnsMutableCopy() {

@Test
public void testGetImmutableMapReturnsNullIfEmpty() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertTrue(map.isEmpty());
assertNull(map.getImmutableMapOrNull());
}

@Test
public void testGetImmutableMapReturnsImmutableMapIfNonEmpty() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
map.put("key1", "value1");
assertFalse(map.isEmpty());

Expand All @@ -214,7 +213,7 @@ public void testGetImmutableMapReturnsImmutableMapIfNonEmpty() {

@Test
public void testGetImmutableMapCopyNotAffectdByContextMapChanges() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
map.put("key1", "value1");
assertFalse(map.isEmpty());

Expand All @@ -230,7 +229,7 @@ public void testGetImmutableMapCopyNotAffectdByContextMapChanges() {

@Test
public void testToStringShowsMapContext() {
final StringArrayThreadContextMap map = new StringArrayThreadContextMap(true);
final StringArrayThreadContextMap map = new StringArrayThreadContextMap();
assertEquals("{}", map.toString());

map.put("key1", "value1");
Expand All @@ -242,24 +241,47 @@ public void testToStringShowsMapContext() {
}

@Test
@ClearSystemProperty(key = StringArrayThreadContextMap.INHERITABLE_MAP)
@InitializesThreadContext
public void testThreadLocalNotInheritableByDefault() {
ThreadContextMapFactory.init();
final ThreadLocal<Object[]> threadLocal = StringArrayThreadContextMap.createThreadLocalMap(true);
assertFalse(threadLocal instanceof InheritableThreadLocal<?>);
public void testEmptyMap() {
assertNull(UnmodifiableArrayBackedMap.EMPTY_MAP.get("test"));
}

@Test
@SetTestProperty(key = StringArrayThreadContextMap.INHERITABLE_MAP, value = "true")
@InitializesThreadContext
public void testThreadLocalInheritableIfConfigured() {
ThreadContextMapFactory.init();
try {
final ThreadLocal<Object[]> threadLocal = StringArrayThreadContextMap.createThreadLocalMap(true);
assertTrue(threadLocal instanceof InheritableThreadLocal<?>);
} finally {
System.clearProperty(StringArrayThreadContextMap.INHERITABLE_MAP);
}
public void testForEachBiConsumer_Log4jUtil() {
StringArrayThreadContextMap map = createMap();
Set<String> keys = new HashSet<>();
org.apache.logging.log4j.util.BiConsumer<String, String> log4j_util_action =
new org.apache.logging.log4j.util.BiConsumer<String, String>() {
@Override
public void accept(String key, String value) {
keys.add(key);
}
};
map.forEach(log4j_util_action);
assertEquals(map.toMap().keySet(), keys);

map.clear();
keys.clear();
map.forEach(log4j_util_action);
assertTrue(keys.isEmpty());
}

@Test
public void testForEachTriConsumer() {
StringArrayThreadContextMap map = createMap();
HashMap<String, String> iterationResultMap = new HashMap<>();
TriConsumer<String, String, Map<String, String>> triConsumer =
new TriConsumer<String, String, Map<String, String>>() {
@Override
public void accept(String k, String v, Map<String, String> s) {
s.put(k, v);
}
};
map.forEach(triConsumer, iterationResultMap);
assertEquals(map.toMap(), iterationResultMap);

map.clear();
iterationResultMap.clear();
map.forEach(triConsumer, iterationResultMap);
assertTrue(iterationResultMap.isEmpty());
}
}
Loading