Add config property for disabling REST Client stacktrace capture

Closes: quarkusio#36092
geoand · Sep 22, 2023 · 9b08ab6 · 9b08ab6
1 parent af4208a
commit 9b08ab6
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 6 deletions.
diff --git a/...st-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientConfig.java b/...st-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientConfig.java
@@ -51,6 +51,7 @@ public class RestClientConfig {
         EMPTY.userAgent = Optional.empty();
         EMPTY.http2 = Optional.empty();
         EMPTY.alpn = Optional.empty();
+        EMPTY.captureStacktrace = Optional.empty();
     }
 
     public RestClientMultipartConfig multipart;
@@ -267,6 +268,13 @@ public class RestClientConfig {
     @ConfigItem
     public Optional<Boolean> alpn;
 
+    /**
+     * If {@code true}, the stacktrace of the invocation of the REST Client method is captured.
+     * This stacktrace will be used if the invocation throws an exception
+     */
+    @ConfigItem
+    public Optional<Boolean> captureStacktrace;
+
     public static RestClientConfig load(String configKey) {
         final RestClientConfig instance = new RestClientConfig();
 
@@ -299,6 +307,7 @@ public static RestClientConfig load(String configKey) {
         instance.name = getConfigValue(configKey, "name", String.class);
         instance.userAgent = getConfigValue(configKey, "user-agent", String.class);
         instance.http2 = getConfigValue(configKey, "http2", Boolean.class);
+        instance.captureStacktrace = getConfigValue(configKey, "capture-stacktrace", Boolean.class);
 
         instance.multipart = new RestClientMultipartConfig();
         instance.multipart.maxChunkSize = getConfigValue(configKey, "multipart.max-chunk-size", Integer.class);
@@ -339,6 +348,7 @@ public static RestClientConfig load(Class<?> interfaceClass) {
         instance.userAgent = getConfigValue(interfaceClass, "user-agent", String.class);
         instance.http2 = getConfigValue(interfaceClass, "http2", Boolean.class);
         instance.alpn = getConfigValue(interfaceClass, "alpn", Boolean.class);
+        instance.captureStacktrace = getConfigValue(interfaceClass, "capture-stacktrace", Boolean.class);
 
         instance.multipart = new RestClientMultipartConfig();
         instance.multipart.maxChunkSize = getConfigValue(interfaceClass, "multipart.max-chunk-size", Integer.class);

diff --git a/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java b/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java
@@ -300,6 +300,13 @@ public class RestClientsConfig {
     @ConfigItem
     public Optional<Boolean> alpn;
 
+    /**
+     * If {@code true}, the stacktrace of the invocation of the REST Client method is captured.
+     * This stacktrace will be used if the invocation throws an exception
+     */
+    @ConfigItem(defaultValue = "true")
+    public boolean captureStacktrace;
+
     public RestClientConfig getClientConfig(String configKey) {
         if (configKey == null) {
             return RestClientConfig.EMPTY;

diff --git a/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilder.java b/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilder.java
@@ -135,6 +135,10 @@ private void configureCustomProperties(QuarkusRestClientBuilder builder) {
         if (alpn.isPresent()) {
             builder.property(QuarkusRestClientProperties.ALPN, alpn.get());
         }
+
+        Boolean captureStacktrace = oneOf(clientConfigByClassName().captureStacktrace,
+                clientConfigByConfigKey().captureStacktrace).orElse(configRoot.captureStacktrace);
+        builder.property(QuarkusRestClientProperties.CAPTURE_STACKTRACE, captureStacktrace);
     }
 
     private void configureProxy(QuarkusRestClientBuilder builder) {

diff --git a/...ime/src/main/java/org/jboss/resteasy/reactive/client/api/QuarkusRestClientProperties.java b/...ime/src/main/java/org/jboss/resteasy/reactive/client/api/QuarkusRestClientProperties.java
@@ -78,4 +78,9 @@ public class QuarkusRestClientProperties {
      */
     public static final String ALPN = "io.quarkus.rest.client.alpn";
 
+    /**
+     * If set to true, the stacktrace of the invocation of the REST Client method is captured
+     */
+    public static final String CAPTURE_STACKTRACE = "io.quarkus.rest.client.capture-stacktrace";
+
 }
diff --git a/...a/org/jboss/resteasy/reactive/client/handlers/ClientCaptureCurrentContextRestHandler.java b/...a/org/jboss/resteasy/reactive/client/handlers/ClientCaptureCurrentContextRestHandler.java
@@ -15,6 +15,12 @@ public class ClientCaptureCurrentContextRestHandler implements ClientRestHandler
 
     private static final String RESTEASY_REACTIVE_PACKAGE = "org.jboss.resteasy.reactive";
     private static final String AUTOGENERATED_TAG = "$$";
+    private static final StackTraceElement[] EMPTY_ARRAY = new StackTraceElement[0];
+    private final boolean captureStacktrace;
+
+    public ClientCaptureCurrentContextRestHandler(boolean captureStacktrace) {
+        this.captureStacktrace = captureStacktrace;
+    }
 
     @Override
     public void handle(RestClientRequestContext requestContext) throws Exception {
@@ -23,7 +29,9 @@ public void handle(RestClientRequestContext requestContext) throws Exception {
             return;
         }
 
-        captureCallerStackTrace(clientRequestContext);
+        if (captureStacktrace) {
+            captureCallerStackTrace(clientRequestContext);
+        }
     }
 
     private void captureCallerStackTrace(ClientRequestContextImpl clientRequestContext) {
@@ -44,6 +52,6 @@ private void captureCallerStackTrace(ClientRequestContextImpl clientRequestConte
         }
 
         clientRequestContext.getRestClientRequestContext()
-                .setCallerStackTrace(effectiveStackTrace.toArray(new StackTraceElement[0]));
+                .setCallerStackTrace(effectiveStackTrace.toArray(EMPTY_ARRAY));
     }
 }
diff --git a/...tive/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/ClientImpl.java b/...tive/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/ClientImpl.java
@@ -1,5 +1,6 @@
 package org.jboss.resteasy.reactive.client.impl;
 
+import static org.jboss.resteasy.reactive.client.api.QuarkusRestClientProperties.CAPTURE_STACKTRACE;
 import static org.jboss.resteasy.reactive.client.api.QuarkusRestClientProperties.CONNECTION_POOL_SIZE;
 import static org.jboss.resteasy.reactive.client.api.QuarkusRestClientProperties.CONNECTION_TTL;
 import static org.jboss.resteasy.reactive.client.api.QuarkusRestClientProperties.CONNECT_TIMEOUT;
@@ -201,10 +202,19 @@ public Vertx get() {
             });
         }
 
-        handlerChain = new HandlerChain(options.getMaxChunkSize(), followRedirects, loggingScope,
+        handlerChain = new HandlerChain(isCaptureStacktrace(configuration), options.getMaxChunkSize(), followRedirects,
+                loggingScope,
                 clientContext.getMultipartResponsesData(), clientLogger);
     }
 
+    private boolean isCaptureStacktrace(ConfigurationImpl configuration) {
+        Object captureStacktraceObj = configuration.getProperty(CAPTURE_STACKTRACE);
+        if (captureStacktraceObj == null) {
+            return false;
+        }
+        return (boolean) captureStacktraceObj;
+    }
+
     public ClientContext getClientContext() {
         return clientContext;
     }

diff --git a/...ve/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/HandlerChain.java b/...ve/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/HandlerChain.java
@@ -36,9 +36,9 @@ class HandlerChain {
 
     private ClientRestHandler preClientSendHandler = null;
 
-    public HandlerChain(int maxChunkSize, boolean followRedirects, LoggingScope loggingScope,
+    public HandlerChain(boolean captureStacktrace, int maxChunkSize, boolean followRedirects, LoggingScope loggingScope,
             Map<Class<?>, MultipartResponseData> multipartData, ClientLogger clientLogger) {
-        this.clientCaptureCurrentContextRestHandler = new ClientCaptureCurrentContextRestHandler();
+        this.clientCaptureCurrentContextRestHandler = new ClientCaptureCurrentContextRestHandler(captureStacktrace);
         this.clientSwitchToRequestContextRestHandler = new ClientSwitchToRequestContextRestHandler();
         this.clientSendHandler = new ClientSendRequestHandler(maxChunkSize, followRedirects, loggingScope, clientLogger,
                 multipartData);

diff --git a/...lient/runtime/src/test/java/org/jboss/resteasy/reactive/client/impl/HandlerChainTest.java b/...lient/runtime/src/test/java/org/jboss/resteasy/reactive/client/impl/HandlerChainTest.java
@@ -20,7 +20,7 @@ public class HandlerChainTest {
     @Test
     public void preSendHandlerIsAlwaysFirst() throws Exception {
 
-        var chain = new HandlerChain(8096, true, LoggingScope.NONE, Collections.emptyMap(), new DefaultClientLogger());
+        var chain = new HandlerChain(false, 8096, true, LoggingScope.NONE, Collections.emptyMap(), new DefaultClientLogger());
 
         ClientRestHandler preHandler = ctx -> {
         };