check duplicate keys (properties) #1269

Only for properties config source : duplicate keys found in te same config source will be logged as warning.
smallrye · Dec 16, 2024 · 1285338 · 1285338
1 parent 940c5a5
commit 1285338
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/implementation/src/main/java/io/smallrye/config/ConfigValueConfigSource.java b/implementation/src/main/java/io/smallrye/config/ConfigValueConfigSource.java
@@ -3,6 +3,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Reader;
+import java.lang.invoke.MethodHandles;
 import java.util.AbstractCollection;
 import java.util.AbstractMap;
 import java.util.AbstractSet;
@@ -14,7 +15,9 @@
 import java.util.Set;
 
 import org.eclipse.microprofile.config.spi.ConfigSource;
+import org.jboss.logging.Logger;
 
+import io.smallrye.config._private.ConfigLogging;
 import io.smallrye.config._private.ConfigMessages;
 
 /**
@@ -340,6 +343,9 @@ final class ConfigValueProperties extends HashMap<String, ConfigValue> {
         private final String configSourceName;
         private final int configSourceOrdinal;
 
+        private static ConfigLogging log = Logger.getMessageLogger(MethodHandles.lookup(), ConfigLogging.class,
+                "io.smallrye.config");
+
         public ConfigValueProperties(final String configSourceName, final int configSourceOrdinal) {
             this.configSourceName = configSourceName;
             this.configSourceOrdinal = configSourceOrdinal;
@@ -401,14 +407,18 @@ private void load0(LineReader lr) throws IOException {
                 }
                 String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
                 String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
-                put(key, ConfigValue.builder()
+                ConfigValue oldConfigValue = put(key, ConfigValue.builder()
                         .withName(key)
                         .withValue(value)
                         .withRawValue(value)
                         .withConfigSourceName(configSourceName)
                         .withConfigSourceOrdinal(configSourceOrdinal)
                         .withLineNumber(lr.lineNumber)
                         .build());
+                if (oldConfigValue != null) {
+                    log.warnv("duplicate keys found for : {0}, source name : {1}", oldConfigValue.getName(),
+                            oldConfigValue.getConfigSourceName());
+                }
             }
         }
 

diff --git a/implementation/src/test/java/io/smallrye/config/ConfigValuePropertiesTest.java b/implementation/src/test/java/io/smallrye/config/ConfigValuePropertiesTest.java
@@ -79,4 +79,17 @@ void wrapValue() throws Exception {
         assertEquals(2, map.get("key2").getLineNumber());
         assertEquals(6, map.get("key3").getLineNumber());
     }
+
+    @Test
+    void logDuplicateKeys() throws Exception {
+        ConfigValueProperties map = new ConfigValueProperties("config", 1);
+        String config = "key=value\n" +
+                "key2=value\n" +
+                "key2=value2\n";
+        map.load(new StringReader(config));
+
+        // property expected with the last value found
+        assertEquals("value2", map.get("key2").getValue());
+    }
+
 }