Provide a FallbackConfigSourceInterceptor and add a test

Also fix the relocations as they were incorrect before.

Author: gsmet

README.md

@@ -63,15 +63,16 @@ public class MyJsonProvider implements JsonProvider {
 }
 ```
 
-## Property Relocation
+## Configuration Properties Relocation
 
-This project includes a configuration property relocation mechanism using SmallRye Config's `RelocateConfigSourceInterceptor`. 
-It supports backward compatibility by allowing both old and new property names:
+In 3.2.0, two configuration properties were renamed to be more consistent with Quarkus configuration.
 
-- Old: `quarkus.log.console.json.enable` → New: `quarkus.log.console.json.enabled`
-- Old: `quarkus.log.file.json.enable` → New: `quarkus.log.file.json.enabled`
+- Old: `quarkus.log.json.console.enable` → New: `quarkus.log.json.console.enabled`
+- Old: `quarkus.log.json.file.enable` → New: `quarkus.log.json.file.enabled`
 
-When using the old property names, a log message will be generated advising to update to the new property names.
+A relocation/fallback mechanism has been added so the old properties are still supported
+but we recomment that you switch to the new ones
+(`quarkus update` will do it for you).
 
 ## Contributors ✨
 

deployment/src/test/java/io/quarkiverse/loggingjson/deployment/JsonDeprecatedConfigTest.java

@@ -0,0 +1,63 @@
+package io.quarkiverse.loggingjson.deployment;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.logging.Handler;
+import java.util.logging.Level;
+import java.util.logging.LogManager;
+import java.util.logging.Logger;
+
+import org.jboss.logmanager.handlers.ConsoleHandler;
+import org.jboss.logmanager.handlers.FileHandler;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkiverse.loggingjson.JsonFormatter;
+import io.quarkus.bootstrap.logging.InitialConfigurator;
+import io.quarkus.bootstrap.logging.QuarkusDelayedHandler;
+import io.quarkus.bootstrap.model.AppArtifact;
+import io.quarkus.test.QuarkusUnitTest;
+
+/**
+ * In this test, we check that the feature is disabled as it is the only way to check the relocation/fallback works.
+ */
+class JsonDeprecatedConfigTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class))
+            .setForcedDependencies(Collections.singletonList(
+                    new AppArtifact("io.quarkus", "quarkus-jackson", System.getProperty("test.quarkus.version"))))
+            .withConfigurationResource("application-json-deprecated-config.properties");
+
+    static {
+        System.setProperty("java.util.logging.manager", org.jboss.logmanager.LogManager.class.getName());
+    }
+
+    @Test
+    void testJsonLoggingDisabled() throws Exception {
+        LogManager logManager = LogManager.getLogManager();
+        Assertions.assertTrue(logManager instanceof org.jboss.logmanager.LogManager);
+
+        QuarkusDelayedHandler delayedHandler = InitialConfigurator.DELAYED_HANDLER;
+        Assertions.assertTrue(Arrays.asList(Logger.getLogger("").getHandlers()).contains(delayedHandler));
+        Assertions.assertEquals(Level.ALL, delayedHandler.getLevel());
+
+        Handler consoleHandler = Arrays.stream(delayedHandler.getHandlers())
+                .filter(h -> (h instanceof ConsoleHandler))
+                .findFirst().orElse(null);
+        Assertions.assertNotNull(consoleHandler);
+
+        Assertions.assertFalse(consoleHandler.getFormatter() instanceof JsonFormatter);
+
+        Handler fileHandler = Arrays.stream(delayedHandler.getHandlers())
+                .filter(h -> (h instanceof FileHandler))
+                .findFirst().orElse(null);
+        Assertions.assertNotNull(fileHandler);
+
+        Assertions.assertFalse(fileHandler.getFormatter() instanceof JsonFormatter);
+    }
+}

deployment/src/test/resources/application-json-deprecated-config.properties

@@ -0,0 +1,8 @@
+quarkus.log.level=INFO
+quarkus.log.console.enable=true
+quarkus.log.console.level=WARNING
+quarkus.log.json.console.enable=false
+quarkus.log.json.fields.arguments.include-non-structured-arguments=true
+quarkus.log.json.additional-field.serviceName.value=deployment-test
+quarkus.log.file.enable=true
+quarkus.log.json.file.enable=false

runtime/src/main/java/io/quarkiverse/loggingjson/config/LoggingConfigFallbackConfigSourceInterceptor.java

@@ -0,0 +1,21 @@
+package io.quarkiverse.loggingjson.config;
+
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
+
+import io.smallrye.config.FallbackConfigSourceInterceptor;
+
+/**
+ * @deprecated maps the old config to the new config, should be removed at some point
+ */
+@Deprecated(forRemoval = true, since = "3.2.0")
+public class LoggingConfigFallbackConfigSourceInterceptor extends FallbackConfigSourceInterceptor {
+
+    private static final Map<String, String> FALLBACKS = LoggingConfigRelocateConfigSourceInterceptor.RELOCATIONS.entrySet()
+            .stream().collect(Collectors.toUnmodifiableMap(Entry::getValue, Entry::getKey));
+
+    public LoggingConfigFallbackConfigSourceInterceptor() {
+        super(FALLBACKS);
+    }
+}

runtime/src/main/java/io/quarkiverse/loggingjson/config/LoggingConfigRelocateConfigSourceInterceptor.java

@@ -1,40 +1,17 @@
 package io.quarkiverse.loggingjson.config;
 
-import java.util.HashSet;
-import java.util.Iterator;
 import java.util.Map;
-import java.util.Set;
 
-import io.smallrye.config.ConfigSourceInterceptorContext;
 import io.smallrye.config.RelocateConfigSourceInterceptor;
 
+@Deprecated(forRemoval = true, since = "3.2.0")
 public class LoggingConfigRelocateConfigSourceInterceptor extends RelocateConfigSourceInterceptor {
 
-    private static final Map<String, String> RELOCATIONS = relocations();
+    static final Map<String, String> RELOCATIONS = Map.of(
+            "quarkus.log.json.console.enable", "quarkus.log.json.console.enabled",
+            "quarkus.log.json.file.enable", "quarkus.log.json.file.enabled");
 
     public LoggingConfigRelocateConfigSourceInterceptor() {
         super(RELOCATIONS);
     }
-
-    @Override
-    public Iterator<String> iterateNames(final ConfigSourceInterceptorContext context) {
-        final Set<String> names = new HashSet<>();
-        final Iterator<String> namesIterator = context.iterateNames();
-        while (namesIterator.hasNext()) {
-            final String name = namesIterator.next();
-            names.add(name);
-            final String mappedName = RELOCATIONS.get(name);
-            if (mappedName != null) {
-                names.add(mappedName);
-            }
-        }
-        return names.iterator();
-    }
-
-    private static Map<String, String> relocations() {
-        return Map.of(
-                "quarkus.log.console.json.enable", "quarkus.log.console.json.enabled",
-                "quarkus.log.file.json.enable", "quarkus.log.file.json.enabled");
-    }
-
 }

runtime/src/main/resources/META-INF/services/io.smallrye.config.ConfigSourceInterceptor

@@ -1 +1,2 @@
 io.quarkiverse.loggingjson.config.LoggingConfigRelocateConfigSourceInterceptor
+io.quarkiverse.loggingjson.config.LoggingConfigFallbackConfigSourceInterceptor