feat: Add a Logger.removeContext function. (#147)

Author: bgrozev

src/main/java/org/jitsi/utils/logging2/Logger.java

@@ -262,4 +262,10 @@ public interface Logger
      * @param value the context value
      */
     void addContext(String key, String value);
+
+    /**
+     * Remove a context key/value pair from this logger.
+     * @param key the key to remove.
+     */
+    void removeContext(String key);
 }

src/main/java/org/jitsi/utils/logging2/LoggerImpl.java

@@ -100,7 +100,7 @@ public void removeHandler(Handler handler) throws SecurityException
     {
         loggerDelegate.removeHandler(handler);
     }
-    
+
     private boolean isLoggable(Level level)
     {
         return level.intValue() >= minLogLevel.intValue() && loggerDelegate.isLoggable(level);
@@ -309,5 +309,11 @@ public void addContext(String key, String value)
         logContext.addContext(key, value);
     }
 
+    @Override
+    public void removeContext(String key)
+    {
+        logContext.removeContext(key);
+    }
+
     static Function<String, java.util.logging.Logger> loggerFactory = java.util.logging.Logger::getLogger;
 }

src/main/kotlin/org/jitsi/utils/logging2/LogContext.kt

@@ -68,6 +68,12 @@ class LogContext private constructor(
 
     fun addContext(key: String, value: String) = addContext(mapOf(key to value))
 
+    @Synchronized
+    fun removeContext(key: String) {
+        context = context - key
+        updateFormattedContext()
+    }
+
     @Synchronized
     fun addContext(addedContext: Map<String, String>) {
         context = context + addedContext

src/test/java/org/jitsi/utils/logging2/LoggerImplTest.java

@@ -140,6 +140,24 @@ public void testLoggingWithContext()
         assertTrue(containsData(contextTokens, "keyOne=value1"));
         assertTrue(containsData(contextTokens, "keyTwo=value2"));
     }
+    @Test
+    public void testRemovingContext()
+    {
+        Map<String, String> ctxData = new HashMap<>();
+        ctxData.put("keyOne", "value1");
+        ctxData.put("keyTwo", "value2");
+        LogContext ctx = new LogContext(ctxData);
+
+        LoggerImpl logger = new LoggerImpl("test", ctx);
+        logger.removeContext("keyOne");
+
+        logger.info("hello, world!");
+
+        String[] contextTokens = fakeLogger.getLastLineContextTokens();
+        assertTrue(containsData(contextTokens, "keyTwo=value2"));
+        assertTrue(Arrays.stream(contextTokens)
+            .noneMatch(token -> token.contains("keyOne")));
+    }
 
     @Test
     public void testChildLoggerInheritsContext()