add support for peekByKey in MDC

Signed-off-by: youjie23 <[email protected]>

Author: youjie_li

slf4j-api/src/main/java/org/slf4j/MDC.java

@@ -313,6 +313,20 @@ static public String popByKey(String key) {
         return getMDCAdapter().popByKey(key);
     }
 
+    /**
+     * Peek the stack referenced by 'key' and return the value possibly null.
+     *
+     * @param key identifies the deque(stack)
+     * @return the value just peeked. May be null/
+     * @since 2.0.18
+     */
+    static public String peekByKey(String key) {
+        if (getMDCAdapter() == null) {
+            throw new IllegalStateException(MDC_APAPTER_CANNOT_BE_NULL_MESSAGE);
+        }
+        return getMDCAdapter().peekByKey(key);
+    }
+
     /**
      * Returns a copy of the deque(stack) referenced by 'key'. May be null.
      * 

slf4j-api/src/main/java/org/slf4j/helpers/BasicMDCAdapter.java

@@ -159,6 +159,11 @@ public String popByKey(String key) {
         return threadLocalMapOfDeques.popByKey(key);    
      }
 
+    @Override
+    public String peekByKey(String key) {
+        return threadLocalMapOfDeques.peekByKey(key);
+     }
+
     @Override
     public Deque<String> getCopyOfDequeByKey(String key) {
         return threadLocalMapOfDeques.getCopyOfDequeByKey(key);

slf4j-api/src/main/java/org/slf4j/helpers/ThreadLocalMapOfStacks.java

@@ -40,32 +40,40 @@ public void pushByKey(String key, String value) {
     }
 
     public String popByKey(String key) {
-        if (key == null)
+        Deque<String> deque = getDeque(key);
+        if (deque == null)
             return null;
 
-        Map<String, Deque<String>> map = tlMapOfStacks.get();
-        if (map == null)
-            return null;
-        Deque<String> deque = map.get(key);
+        return deque.pop();
+    }
+
+    public String peekByKey(String key) {
+        Deque<String> deque = getDeque(key);
         if (deque == null)
             return null;
-        return deque.pop();
+
+        return deque.peek();
     }
 
     public Deque<String> getCopyOfDequeByKey(String key) {
+        Deque<String> deque = getDeque(key);
+        if (deque == null)
+            return null;
+
+        return new ArrayDeque<String>(deque);
+    }
+
+    private Deque<String> getDeque(String key) {
         if (key == null)
             return null;
 
         Map<String, Deque<String>> map = tlMapOfStacks.get();
         if (map == null)
             return null;
-        Deque<String> deque = map.get(key);
-        if (deque == null)
-            return null;
 
-        return new ArrayDeque<String>(deque);
+        return map.get(key);
     }
-    
+
     /**
      * Clear the deque(stack) referenced by 'key'. 
      * 
@@ -74,15 +82,10 @@ public Deque<String> getCopyOfDequeByKey(String key) {
      * @since 2.0.0
      */
     public void clearDequeByKey(String key) {
-        if (key == null)
-            return;
-
-        Map<String, Deque<String>> map = tlMapOfStacks.get();
-        if (map == null)
-            return;
-        Deque<String> deque = map.get(key);
+        Deque<String> deque = getDeque(key);
         if (deque == null)
             return;
+
         deque.clear();
     }
 

slf4j-api/src/main/java/org/slf4j/spi/MDCAdapter.java

@@ -110,6 +110,19 @@ public interface MDCAdapter {
      */
     public String popByKey(String key);
 
+    /**
+     * peek the stack referenced by 'key' and return the value possibly null.
+     *
+     * @param key identifies the deque(stack)
+     * @return the value just peeked. May be null/
+     * @since 2.0.18
+     */
+    default  public String peekByKey(String key){
+        Deque<String>  deque = getCopyOfDequeByKey(key);
+        if(deque == null)
+            return  null;
+        return deque.peek();
+    }
     /**
      * Returns a copy of the deque(stack) referenced by 'key'. May be null.
      * 

slf4j-api/src/test/java/org/slf4j/helpers/MDCAdapterTestBase.java

@@ -24,18 +24,16 @@
 
 package org.slf4j.helpers;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.fail;
-
 import java.lang.Thread.UncaughtExceptionHandler;
 import java.util.Map;
+import java.util.NoSuchElementException;
 
 import org.junit.After;
 import org.junit.Test;
 import org.slf4j.spi.MDCAdapter;
 
+import static org.junit.Assert.*;
+
 /**
  * Tests for {@link BasicMDCAdapter}
  * 
@@ -64,6 +62,25 @@ public void testSettingAndGettingWithMDC() {
         assertEquals(mdc.get("testKey"), "testValue");
     }
 
+    @Test
+    public void testPushingAndPoppingWithMDC() {
+        assertNull(mdc.popByKey("testKey"));
+        mdc.pushByKey("testKey", "testValue");
+        mdc.pushByKey("testKey", "differentTestValue");
+        assertEquals(mdc.popByKey("testKey"), "differentTestValue");
+        assertEquals(mdc.popByKey("testKey"), "testValue");
+        assertThrows(NoSuchElementException.class, () -> mdc.popByKey("testKey"));
+    }
+
+    @Test
+    public void testPushingAndPeekingWithMDC() {
+        assertNull(mdc.peekByKey("testKey"));
+        mdc.pushByKey("testKey", "testValue");
+        mdc.pushByKey("testKey", "differentTestValue");
+        assertEquals(mdc.peekByKey("testKey"), "differentTestValue");
+        assertEquals(mdc.peekByKey("testKey"), "differentTestValue");
+    }
+
     @Test
     public void testOverwritingAKeyInMDC() {
         assertNull(mdc.get("testKey"));