Merge branch 'quarkiverse:main' into feature/load-jackson-modules-from-classpath

IvanPuntev · web-flow · commit 74efda17b96c · 2025-10-27T23:52:25.000+02:00
diff --git a/.github/project.yml b/.github/project.yml
@@ -1,4 +1,4 @@
 name: Quarkus Logging JSON
 release:
-  current-version: 3.3.1
-  next-version: 3.3.2-SNAPSHOT
+  current-version: 3.4.0
+  next-version: 3.4.1-SNAPSHOT
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -61,4 +61,4 @@ jobs:
       - name: Check for uncommitted changes
         run: |
           err_msg="Changes found!!! Run 'mvn -B clean package' and commit changes"
-          git -c color.ui=always diff --exit-code || (>&2 echo "${err_msg}" && exit 1)
+          git -c color.ui=always diff --exit-code ':(exclude)docs/modules/ROOT/pages/includes/attributes.adoc' || (>&2 echo "${err_msg}" && exit 1)
diff --git a/deployment/pom.xml b/deployment/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.quarkiverse.loggingjson</groupId>
         <artifactId>quarkus-logging-json-parent</artifactId>
-        <version>3.3.2-SNAPSHOT</version>
+        <version>3.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -23,7 +23,7 @@
         <dependency>
             <groupId>io.quarkiverse.loggingjson</groupId>
             <artifactId>quarkus-logging-json</artifactId>
-            <version>3.3.2-SNAPSHOT</version>
+            <version>3.4.1-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc
@@ -1,3 +1,3 @@
-:project-version: 3.3.1
+:project-version: 3.4.0
 
 :examples-dir: ./../examples/
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.quarkiverse.loggingjson</groupId>
         <artifactId>quarkus-logging-json-parent</artifactId>
-        <version>3.3.2-SNAPSHOT</version>
+        <version>3.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/integration-tests/pom.xml b/integration-tests/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.quarkiverse.loggingjson</groupId>
         <artifactId>quarkus-logging-json-parent</artifactId>
-        <version>3.3.2-SNAPSHOT</version>
+        <version>3.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/pom.xml b/pom.xml
@@ -10,7 +10,7 @@
     <groupId>io.quarkiverse.loggingjson</groupId>
     <artifactId>quarkus-logging-json-parent</artifactId>
     <name>Quarkus Logging JSON - Parent</name>
-    <version>3.3.2-SNAPSHOT</version>
+    <version>3.4.1-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <properties>
diff --git a/runtime/pom.xml b/runtime/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.quarkiverse.loggingjson</groupId>
         <artifactId>quarkus-logging-json-parent</artifactId>
-        <version>3.3.2-SNAPSHOT</version>
+        <version>3.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/runtime/src/main/java/io/quarkiverse/loggingjson/JsonFactory.java b/runtime/src/main/java/io/quarkiverse/loggingjson/JsonFactory.java
@@ -2,7 +2,10 @@
 
 import java.io.IOException;
 
+import io.quarkiverse.loggingjson.config.Config;
+
 public interface JsonFactory {
+    void setConfig(Config config);
 
     JsonGenerator createGenerator(StringBuilderWriter writer) throws IOException;
 }
diff --git a/runtime/src/main/java/io/quarkiverse/loggingjson/LoggingJsonRecorder.java b/runtime/src/main/java/io/quarkiverse/loggingjson/LoggingJsonRecorder.java
@@ -44,6 +44,7 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f
         if (formatter == null || !formatter.isEnabled()) {
             return new RuntimeValue<>(Optional.empty());
         }
+        jsonFactory.setConfig(config);
 
         List<JsonProvider> providers;
 
@@ -71,7 +72,6 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f
         }
 
         return new RuntimeValue<>(Optional.of(new JsonFormatter(providers, jsonFactory, config)));
-
     }
 
     private List<JsonProvider> defaultFormat(Config config) {
diff --git a/runtime/src/main/java/io/quarkiverse/loggingjson/jackson/JacksonJsonFactory.java b/runtime/src/main/java/io/quarkiverse/loggingjson/jackson/JacksonJsonFactory.java
@@ -3,22 +3,24 @@
 import java.io.IOException;
 import java.util.ServiceConfigurationError;
 
+import com.fasterxml.jackson.core.JsonFactoryBuilder;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 
 import io.quarkiverse.loggingjson.JsonFactory;
 import io.quarkiverse.loggingjson.JsonGenerator;
 import io.quarkiverse.loggingjson.StringBuilderWriter;
+import io.quarkiverse.loggingjson.config.Config;
 
 public class JacksonJsonFactory implements JsonFactory {
 
-    private final com.fasterxml.jackson.core.JsonFactory jsonFactory;
+    private com.fasterxml.jackson.core.JsonFactory jsonFactory;
 
     public JacksonJsonFactory() {
-        jsonFactory = createJsonFactory();
+        jsonFactory = createJsonFactory(false);
     }
 
-    private com.fasterxml.jackson.core.JsonFactory createJsonFactory() {
+    private com.fasterxml.jackson.core.JsonFactory createJsonFactory(boolean prettyPrint) {
         ObjectMapper objectMapper = new ObjectMapper()
                 /*
                  * Assume empty beans are ok.
@@ -30,28 +32,25 @@ private com.fasterxml.jackson.core.JsonFactory createJsonFactory() {
         } catch (ServiceConfigurationError serviceConfigurationError) {
             // TODO Fix output of error message
 
-            //                addError("Error occurred while dynamically loading jackson modules", serviceConfigurationError);
             System.err.println("Error occurred while dynamically loading jackson modules");
             serviceConfigurationError.printStackTrace();
         }
 
-        return objectMapper
-                .getFactory()
-                /*
-                 * When generators are flushed, don't flush the underlying outputStream.
-                 *
-                 * This allows some streaming optimizations when using an encoder.
-                 *
-                 * The encoder generally determines when the stream should be flushed
-                 * by an 'immediateFlush' property.
-                 *
-                 * The 'immediateFlush' property of the encoder can be set to false
-                 * when the appender performs the flushes at appropriate times
-                 * (such as the end of a batch in the AbstractLogstashTcpSocketAppender).
-                 */
+        final JsonFactoryBuilder builder = new JsonFactoryBuilder(objectMapper.getFactory());
+        if (prettyPrint) {
+            builder.addDecorator((factory, generator) -> generator.useDefaultPrettyPrinter());
+        }
+        return builder
+                .build()
+                .setCodec(objectMapper)
                 .disable(com.fasterxml.jackson.core.JsonGenerator.Feature.FLUSH_PASSED_TO_STREAM);
     }
 
+    @Override
+    public void setConfig(Config config) {
+        jsonFactory = createJsonFactory(config.prettyPrint());
+    }
+
     @Override
     public JsonGenerator createGenerator(StringBuilderWriter writer) throws IOException {
         return new JacksonJsonGenerator(jsonFactory.createGenerator(writer));
diff --git a/runtime/src/main/java/io/quarkiverse/loggingjson/jsonb/JsonbJsonFactory.java b/runtime/src/main/java/io/quarkiverse/loggingjson/jsonb/JsonbJsonFactory.java
@@ -1,6 +1,7 @@
 package io.quarkiverse.loggingjson.jsonb;
 
 import java.util.HashMap;
+import java.util.Map;
 
 import jakarta.json.Json;
 import jakarta.json.stream.JsonGeneratorFactory;
@@ -11,14 +12,24 @@
 import io.quarkiverse.loggingjson.JsonFactory;
 import io.quarkiverse.loggingjson.JsonGenerator;
 import io.quarkiverse.loggingjson.StringBuilderWriter;
+import io.quarkiverse.loggingjson.config.Config;
 
 public class JsonbJsonFactory implements JsonFactory {
 
-    private final JsonGeneratorFactory factory;
-    private final YassonJsonb jsonb;
+    private JsonGeneratorFactory factory;
+    private YassonJsonb jsonb;
 
     public JsonbJsonFactory() {
-        factory = Json.createGeneratorFactory(new HashMap<>());
+        setConfig(null);
+    }
+
+    @Override
+    public void setConfig(Config config) {
+        Map<String, Object> jsonConfig = new HashMap<>();
+        if (config != null && config.prettyPrint()) {
+            jsonConfig.put(jakarta.json.stream.JsonGenerator.PRETTY_PRINTING, Boolean.TRUE);
+        }
+        factory = Json.createGeneratorFactory(jsonConfig);
         jsonb = (YassonJsonb) new JsonBindingBuilder().build();
     }
 
diff --git a/runtime/src/test/java/io/quarkiverse/loggingjson/JsonFormatterJacksonTest.java b/runtime/src/test/java/io/quarkiverse/loggingjson/JsonFormatterJacksonTest.java
@@ -0,0 +1,14 @@
+package io.quarkiverse.loggingjson;
+
+class JsonFormatterJacksonTest extends JsonFormatterJsonbTest {
+
+    public JsonFormatterJacksonTest() {
+        expectedPrettyPrintMessage = "{\n  \"message\" : \"TestMessage\"\n}\n";
+    }
+
+    @Override
+    protected Type type() {
+        return Type.JACKSON;
+    }
+
+}
diff --git a/runtime/src/test/java/io/quarkiverse/loggingjson/JsonFormatterJsonbTest.java b/runtime/src/test/java/io/quarkiverse/loggingjson/JsonFormatterJsonbTest.java
@@ -0,0 +1,53 @@
+package io.quarkiverse.loggingjson;
+
+import java.util.List;
+import java.util.Map;
+import java.util.logging.Level;
+
+import org.jboss.logmanager.ExtLogRecord;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import io.quarkiverse.loggingjson.config.Config;
+import io.quarkiverse.loggingjson.providers.JsonProviderBaseTest;
+import io.quarkiverse.loggingjson.providers.MessageJsonProvider;
+
+class JsonFormatterJsonbTest extends JsonProviderBaseTest {
+
+    protected String expectedPrettyPrintMessage = "{\n    \"message\": \"TestMessage\"\n}\n";
+
+    @Override
+    protected Type type() {
+        return Type.JSONB;
+    }
+
+    @Test
+    void format() {
+        final Config config = GetConfig(Map.of());
+
+        final JsonFormatter formatter = new JsonFormatter(List.of(new MessageJsonProvider(config.fields().message())),
+                getJsonFactory(config), config);
+
+        final ExtLogRecord event = new ExtLogRecord(Level.ALL, "TestMessage", "");
+        final String formatted = formatter.format(event);
+
+        Assertions.assertNotNull(formatted);
+        Assertions.assertFalse(formatted.isEmpty());
+        Assertions.assertEquals("{\"message\":\"TestMessage\"}\n", formatted);
+    }
+
+    @Test
+    void formatPrettyPrint() {
+        final Config config = GetConfig(Map.of("quarkus.log.json.pretty-print", "true"));
+
+        final JsonFormatter formatter = new JsonFormatter(List.of(new MessageJsonProvider(config.fields().message())),
+                getJsonFactory(config), config);
+
+        final ExtLogRecord event = new ExtLogRecord(Level.ALL, "TestMessage", "");
+        final String formatted = formatter.format(event);
+
+        Assertions.assertNotNull(formatted);
+        Assertions.assertFalse(formatted.isEmpty());
+        Assertions.assertEquals(expectedPrettyPrintMessage, formatted);
+    }
+}
diff --git a/runtime/src/test/java/io/quarkiverse/loggingjson/providers/JsonProviderBaseTest.java b/runtime/src/test/java/io/quarkiverse/loggingjson/providers/JsonProviderBaseTest.java
@@ -1,6 +1,7 @@
 package io.quarkiverse.loggingjson.providers;
 
 import java.io.IOException;
+import java.util.Map;
 import java.util.Optional;
 
 import org.jboss.logmanager.ExtLogRecord;
@@ -15,28 +16,42 @@
 import io.quarkiverse.loggingjson.config.Config;
 import io.quarkiverse.loggingjson.jackson.JacksonJsonFactory;
 import io.quarkiverse.loggingjson.jsonb.JsonbJsonFactory;
+import io.smallrye.config.SmallRyeConfigBuilder;
+import io.smallrye.config.common.MapBackedConfigSource;
 
-abstract class JsonProviderBaseTest {
+public abstract class JsonProviderBaseTest {
 
-    private static final JsonFactory jsonb = new JsonbJsonFactory();
-    private static final JsonFactory jackson = new JacksonJsonFactory();
     private static final ObjectMapper mapper = new ObjectMapper();
 
     protected abstract Type type();
 
-    private JsonFactory getJsonFactory() {
+    protected static Config GetConfig(Map<String, String> values) {
+        return new SmallRyeConfigBuilder()
+                .withMapping(Config.class)
+                .withSources(new MapBackedConfigSource("test", values) {
+                })
+                .build()
+                .getConfigMapping(Config.class);
+    }
+
+    protected JsonFactory getJsonFactory(Config config) {
+        JsonFactory jsonFactory;
         switch (type()) {
             case JSONB:
-                return jsonb;
+                jsonFactory = new JsonbJsonFactory();
+                break;
             case JACKSON:
-                return jackson;
+                jsonFactory = new JacksonJsonFactory();
+                break;
             default:
                 throw new RuntimeException("Unsupported type");
         }
+        jsonFactory.setConfig(config);
+        return jsonFactory;
     }
 
     protected JsonGenerator getGenerator(StringBuilderWriter writer) throws IOException {
-        return getJsonFactory().createGenerator(writer);
+        return getJsonFactory(GetConfig(Map.of())).createGenerator(writer);
     }
 
     protected String getResult(JsonProvider jsonProvider, ExtLogRecord event) throws IOException {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-:project-version: 3.3.1`
	`1`	`+:project-version: 3.4.0`
`2`	`2`
`3`	`3`	`:examples-dir: ./../examples/`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,10 @@`
`2`	`2`
`3`	`3`	`import java.io.IOException;`
`4`	`4`
	`5`	`+import io.quarkiverse.loggingjson.config.Config;`
	`6`	`+`
`5`	`7`	`public interface JsonFactory {`
	`8`	`+ void setConfig(Config config);`
`6`	`9`
`7`	`10`	`JsonGenerator createGenerator(StringBuilderWriter writer) throws IOException;`
`8`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f`
`44`	`44`	`if (formatter == null \|\| !formatter.isEnabled()) {`
`45`	`45`	`return new RuntimeValue<>(Optional.empty());`
`46`	`46`	`}`
	`47`	`+ jsonFactory.setConfig(config);`
`47`	`48`
`48`	`49`	`List<JsonProvider> providers;`
`49`	`50`
`@@ -71,7 +72,6 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f`
`71`	`72`	`}`
`72`	`73`
`73`	`74`	`return new RuntimeValue<>(Optional.of(new JsonFormatter(providers, jsonFactory, config)));`
`74`		`-`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`private List<JsonProvider> defaultFormat(Config config) {`