Allow for setting logging scope programmatically

Without this change, the logger that can be provided programmatically is totally useful unless the user also configures a Quarkus config property. This change allows for logging to actually be useful in a programmatically created client
gsmet · Oct 17, 2023 · 59e2314 · 59e2314
1 parent f62e45b
commit 59e2314
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/...ctive/runtime/src/main/java/io/quarkus/rest/client/reactive/QuarkusRestClientBuilder.java b/...ctive/runtime/src/main/java/io/quarkus/rest/client/reactive/QuarkusRestClientBuilder.java
@@ -17,6 +17,7 @@
 import org.eclipse.microprofile.rest.client.ext.QueryParamStyle;
 import org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener;
 import org.jboss.resteasy.reactive.client.api.ClientLogger;
+import org.jboss.resteasy.reactive.client.api.LoggingScope;
 
 import io.quarkus.rest.client.reactive.runtime.QuarkusRestClientBuilderImpl;
 import io.quarkus.rest.client.reactive.runtime.RestClientBuilderImpl;
@@ -259,6 +260,14 @@ static QuarkusRestClientBuilder newBuilder() {
      */
     QuarkusRestClientBuilder clientLogger(ClientLogger clientLogger);
 
+    /**
+     * Specifies the client logger to use.
+     *
+     * @param loggingScope to use
+     * @return the current builder
+     */
+    QuarkusRestClientBuilder loggingScope(LoggingScope loggingScope);
+
     /**
      * Based on the configured QuarkusRestClientBuilder, creates a new instance of the given REST interface to invoke API calls
      * against.

diff --git a/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/QuarkusRestClientBuilderImpl.java b/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/QuarkusRestClientBuilderImpl.java
@@ -15,6 +15,7 @@
 import org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory;
 import org.eclipse.microprofile.rest.client.ext.QueryParamStyle;
 import org.jboss.resteasy.reactive.client.api.ClientLogger;
+import org.jboss.resteasy.reactive.client.api.LoggingScope;
 
 import io.quarkus.rest.client.reactive.QuarkusRestClientBuilder;
 import io.quarkus.rest.client.reactive.runtime.context.ClientHeadersFactoryContextResolver;
@@ -224,6 +225,12 @@ public QuarkusRestClientBuilder clientLogger(ClientLogger clientLogger) {
         return this;
     }
 
+    @Override
+    public QuarkusRestClientBuilder loggingScope(LoggingScope loggingScope) {
+        proxy.loggingScope(loggingScope);
+        return this;
+    }
+
     @Override
     public <T> T build(Class<T> clazz) throws IllegalStateException, RestClientDefinitionException {
         return proxy.build(clazz);

diff --git a/.../runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientBuilderImpl.java b/.../runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientBuilderImpl.java
@@ -70,6 +70,7 @@ public class RestClientBuilderImpl implements RestClientBuilder {
     private String nonProxyHosts;
 
     private ClientLogger clientLogger;
+    private LoggingScope loggingScope;
 
     @Override
     public RestClientBuilderImpl baseUrl(URL url) {
@@ -167,6 +168,11 @@ public RestClientBuilderImpl clientLogger(ClientLogger clientLogger) {
         return this;
     }
 
+    public RestClientBuilderImpl loggingScope(LoggingScope loggingScope) {
+        this.loggingScope = loggingScope;
+        return this;
+    }
+
     @Override
     public RestClientBuilderImpl executorService(ExecutorService executor) {
         throw new IllegalArgumentException("Specifying executor service is not supported. " +
@@ -333,10 +339,15 @@ public <T> T build(Class<T> aClass) throws IllegalStateException, RestClientDefi
         RestClientsConfig restClientsConfig = arcContainer.instance(RestClientsConfig.class).get();
 
         RestClientLoggingConfig logging = restClientsConfig.logging;
-        LoggingScope loggingScope = logging != null ? logging.scope.map(LoggingScope::forName).orElse(LoggingScope.NONE)
-                : LoggingScope.NONE;
+
+        LoggingScope effectiveLoggingScope = loggingScope; // if a scope was specified programmatically, it takes precedence
+        if (effectiveLoggingScope == null) {
+            effectiveLoggingScope = logging != null ? logging.scope.map(LoggingScope::forName).orElse(LoggingScope.NONE)
+                    : LoggingScope.NONE;
+        }
+
         Integer loggingBodySize = logging != null ? logging.bodyLimit : 100;
-        clientBuilder.loggingScope(loggingScope);
+        clientBuilder.loggingScope(effectiveLoggingScope);
         clientBuilder.loggingBodySize(loggingBodySize);
         if (clientLogger != null) {
             clientBuilder.clientLogger(clientLogger);