#31 - By default register RequestLogger - add HttpClientContext.requestLogging(boolean) to enable disable

Author: rbygrave

client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java

@@ -18,6 +18,7 @@ class DHttpClientContextBuilder implements HttpClientContext.Builder {
 
   private HttpClient client;
   private String baseUrl;
+  private boolean requestLogging = true;
   private Duration requestTimeout = Duration.ofSeconds(20);
   private BodyAdapter bodyAdapter;
   private RetryHandler retryHandler;
@@ -69,6 +70,12 @@ public HttpClientContext.Builder retryHandler(RetryHandler retryHandler) {
     return this;
   }
 
+  @Override
+  public HttpClientContext.Builder requestLogging(boolean requestLogging) {
+    this.requestLogging = requestLogging;
+    return this;
+  }
+
   @Override
   public HttpClientContext.Builder requestListener(RequestListener requestListener) {
     this.listeners.add(requestListener);
@@ -148,6 +155,10 @@ public HttpClientContext build() {
     if (client == null) {
       client = defaultClient();
     }
+    if (requestLogging) {
+      // register the built in request/response logging
+      requestListener(new RequestLogger());
+    }
     return new DHttpClientContext(client, baseUrl, requestTimeout, bodyAdapter, retryHandler, buildListener(), authTokenProvider, buildIntercept());
   }
 
@@ -173,8 +184,8 @@ private RequestIntercept buildIntercept() {
 
   private HttpClient defaultClient() {
     final HttpClient.Builder builder = HttpClient.newBuilder()
-        .followRedirects(redirect)
-        .connectTimeout(Duration.ofSeconds(20));
+      .followRedirects(redirect)
+      .connectTimeout(Duration.ofSeconds(20));
     if (cookieHandler != null) {
       builder.cookieHandler(cookieHandler);
     }

client/src/main/java/io/avaje/http/client/HttpClientContext.java

@@ -171,13 +171,42 @@ interface Builder {
      */
     Builder retryHandler(RetryHandler retryHandler);
 
+    /**
+     * Disable or enable built in request and response logging.
+     * <p>
+     * By default request logging is enabled. Set this to false to stop
+     * the default {@link RequestLogger} being registered to log
+     * request and response headers and bodies etc.
+     * <p>
+     * With logging level set to {@code DEBUG} for
+     * {@code io.avaje.http.client.RequestLogger} the request and
+     * response are logged with headers only.
+     * <p>
+     * Set the logging level to {@code TRACE} to include the request
+     * and response body payloads (with truncation for large bodies).
+     *
+     * <h3>Suppression</h3>
+     * <p>
+     * We can also use {@link HttpClientRequest#suppressLogging()} to suppress
+     * logging on specific requests.
+     * <p>
+     * Logging of Authorization headers is suppressed.
+     * {@link AuthTokenProvider} requests are suppressed.
+     *
+     * @param requestLogging To turn disable/enable the registration of the default logger
+     * @see RequestLogger
+     */
+    Builder requestLogging(boolean requestLogging);
+
     /**
      * Add a request listener. Multiple listeners may be added, when
      * do so they will process events in the order they were added.
      * <p>
-     * Note that {@link RequestLogger} is an
-     * implementation for debug logging request/response headers and
-     * content.
+     * Note that {@link RequestLogger} is an implementation for debug
+     * logging request/response headers and content which is registered
+     * by default depending on {@link #requestLogging(boolean)}.
+     *
+     * @see RequestLogger
      */
     Builder requestListener(RequestListener requestListener);
 

client/src/test/java/io/avaje/http/client/AuthTokenTest.java

@@ -48,7 +48,6 @@ void sendEmail() {
     HttpClientContext ctx = HttpClientContext.newBuilder()
       .baseUrl("https://foo")
       .bodyAdapter(new JacksonBodyAdapter(objectMapper))
-      .requestListener(new RequestLogger())
       .authTokenProvider(new MyAuthTokenProvider())
       .build();
 

client/src/test/java/io/avaje/http/client/BaseWebTest.java

@@ -26,9 +26,7 @@ public static void shutdown() {
   public static HttpClientContext client() {
     return HttpClientContext.newBuilder()
       .baseUrl(baseUrl)
-      .requestListener(new RequestLogger())
       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
-//      .withBodyAdapter(new GsonBodyAdapter(new Gson()))
       .build();
   }
 }

client/src/test/java/io/avaje/http/client/DHttpApiTest.java

@@ -1,10 +1,8 @@
 package io.avaje.http.client;
 
-import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import org.example.github.Repo;
 import org.example.github.Simple;
-import org.example.github.SimpleHttpClient;
+import org.example.github.httpclient.Simple$HttpClient;
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
@@ -22,7 +20,7 @@ void test_github_listRepos() {
       .build();
 
     DHttpApi httpApi = new DHttpApi();
-    httpApi.addProvider(new SimpleHttpClient.Provider());
+    httpApi.addProvider(new Simple$HttpClient.Provider());
     final Simple simple = httpApi.provideFor(Simple.class, clientContext);
 
     final List<Repo> repos = simple.listRepos("rbygrave", "junk");

client/src/test/java/io/avaje/http/client/HelloBasicAuthTest.java

@@ -14,7 +14,6 @@ class HelloBasicAuthTest extends BaseWebTest {
   public static HttpClientContext client() {
     return HttpClientContext.newBuilder()
       .baseUrl(baseUrl)
-      .requestListener(new RequestLogger())
       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
       .requestIntercept(new BasicAuthIntercept("rob", "bot"))
       .build();

client/src/test/java/io/avaje/http/client/RequestListenerTest.java

@@ -36,6 +36,7 @@ public void response(Event event) {
   private HttpClientContext createClient(TDRequestListener tdRequestListener) {
     return HttpClientContext.newBuilder()
       .baseUrl(baseUrl)
+      .requestLogging(false)
       .requestListener(new RequestLogger())
       .bodyAdapter(new JacksonBodyAdapter())
       .requestListener(tdRequestListener)

client/src/test/java/io/avaje/http/client/RetryTest.java

@@ -16,7 +16,6 @@ HttpClientContext initClientWithRetry() {
     return HttpClientContext.newBuilder()
       .baseUrl("http://localhost:8887")
       .bodyAdapter(new JacksonBodyAdapter())
-      .requestListener(new RequestLogger())
       .retryHandler(new SimpleRetryHandler(4, 1))
       .requestIntercept(myIntercept)
       .build();

client/src/test/java/org/example/github/GithubTest.java

@@ -19,7 +19,7 @@ void test() throws InterruptedException {
     final HttpClientContext clientContext = HttpClientContext.newBuilder()
       .baseUrl("https://api.github.com")
       .bodyAdapter(new JacksonBodyAdapter())
-      .requestListener(new RequestLogger())
+      .requestLogging(false)
       .build();
 
     clientContext.request()

client/src/test/java/org/example/github/SimpleProvider.java

@@ -2,6 +2,7 @@
 
 import io.avaje.http.client.HttpApiProvider;
 import io.avaje.http.client.HttpClientContext;
+import org.example.github.httpclient.Simple$HttpClient;
 
 public class SimpleProvider implements HttpApiProvider<Simple> {
 
@@ -12,6 +13,6 @@ public Class<Simple> type() {
 
   @Override
   public Simple provide(HttpClientContext client) {
-    return new SimpleHttpClient(client);
+    return new Simple$HttpClient(client);
   }
 }