Merge pull request #4 from razkl/add-option-to-set-log-level-on-request

add option to set log level on request

Author: nadavvitri

src/main/java/com/taboola/rest/api/RestAPIClient.java

@@ -1,5 +1,7 @@
 package com.taboola.rest.api;
 
+import okhttp3.logging.HttpLoggingInterceptor;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -18,6 +20,7 @@
 import com.taboola.rest.api.internal.config.SerializationConfig;
 import com.taboola.rest.api.internal.config.UserAgentHeader;
 import com.taboola.rest.api.internal.serialization.SerializationMapperCreator;
+import com.taboola.rest.api.model.HttpLoggingLevel;
 import com.taboola.rest.api.model.RequestHeader;
 import com.taboola.rest.api.model.StringResponseFactory;
 
@@ -72,6 +75,12 @@ public static class RestAPIClientBuilder {
         private ExceptionFactory exceptionFactory;
         private ObjectMapper objectMapper;
         private final StringResponseFactories stringResponseFactories = new StringResponseFactories();
+        private HttpLoggingLevel loggingLevel;
+
+        public RestAPIClientBuilder setLoggingLevel(HttpLoggingLevel loggingLevel) {
+            this.loggingLevel = loggingLevel;
+            return this;
+        }
 
         public RestAPIClientBuilder setBaseUrl(String baseUrl) {
             this.baseUrl = baseUrl;
@@ -153,7 +162,7 @@ public RestAPIClient build() {
             String finalUserAgent = String.format("%s/%s/%s (%s)", userAgentPrefix, restAPIVersion, VERSION, userAgentSuffix);
             Collection<RequestHeader> headers = getAllHeaders(this.headers, finalUserAgent);
             CommunicationConfig config = new CommunicationConfig(baseUrl, connectionTimeoutMillis, readTimeoutMillis, writeTimeoutMillis, maxIdleConnections,
-                    keepAliveDurationMillis, headers, debug, exceptionFactory, objectMapper, stringResponseFactories);
+                    keepAliveDurationMillis, headers, debug, exceptionFactory, objectMapper, stringResponseFactories, loggingLevel);
             return new RestAPIClient(new CommunicationFactory(config));
         }
 
@@ -220,6 +229,10 @@ private void organizeState() {
             if (objectMapper == null) {
                 objectMapper = SerializationMapperCreator.createObjectMapper(serializationConfig);
             }
+
+            if (loggingLevel == null) {
+                loggingLevel = HttpLoggingLevel.BASIC;
+            }
         }
     }
 

src/main/java/com/taboola/rest/api/internal/CommunicationFactory.java

@@ -5,21 +5,25 @@
 import com.taboola.rest.api.internal.config.CommunicationConfig;
 import com.taboola.rest.api.internal.interceptors.CommunicationInterceptor;
 import com.taboola.rest.api.internal.interceptors.HeadersInterceptor;
+import com.taboola.rest.api.model.HttpLoggingLevel;
 
 import okhttp3.ConnectionPool;
 import okhttp3.OkHttpClient;
 import okhttp3.logging.HttpLoggingInterceptor;
 import retrofit2.Retrofit;
 import retrofit2.converter.jackson.JacksonConverterFactory;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
 /**
  * Created by vladi
  * Date: 10/4/2017
  * Time: 10:54 PM
  * By Taboola
  */
 public final class CommunicationFactory {
-
+    private static final Logger logger = LogManager.getLogger(CommunicationFactory.class);
     private final Retrofit retrofit;
 
     public CommunicationFactory(CommunicationConfig communicationConfig) {
@@ -32,12 +36,13 @@ private HttpLoggingInterceptor createLoggingInterceptor(CommunicationConfig conf
         HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(new CommunicationInterceptor());
         if (config.isDebug()) {
             loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
+        } else {
+            loggingInterceptor.setLevel(getHttpLoggingInterceptorLevel(config.getLoggingLevel()));
+        }
+        if (loggingInterceptor.getLevel() == HttpLoggingInterceptor.Level.BODY || loggingInterceptor.getLevel() == HttpLoggingInterceptor.Level.HEADERS) {
             loggingInterceptor.redactHeader("Authorization");
             loggingInterceptor.redactHeader("Cookie");
-        } else {
-            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BASIC);
         }
-
         return loggingInterceptor;
     }
 
@@ -61,6 +66,23 @@ private OkHttpClient createOkHttpClient(CommunicationConfig config) {
                 .build();
     }
 
+
+    public static HttpLoggingInterceptor.Level getHttpLoggingInterceptorLevel(HttpLoggingLevel httpLoggingLevel) {
+        switch (httpLoggingLevel) {
+            case NONE:
+                return HttpLoggingInterceptor.Level.NONE;
+            case BASIC:
+                return HttpLoggingInterceptor.Level.BASIC;
+            case HEADERS:
+                return HttpLoggingInterceptor.Level.HEADERS;
+            case BODY:
+                return HttpLoggingInterceptor.Level.BODY;
+            default:
+                logger.error("Getting unknown HttpLoggingLevel [{}]", httpLoggingLevel.name());
+                return HttpLoggingInterceptor.Level.BASIC;
+        }
+    }
+
     public <E> E createRetrofitEndpoint(Class<E> clazz) {
         return retrofit.create(clazz);
     }

src/main/java/com/taboola/rest/api/internal/config/CommunicationConfig.java

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.taboola.rest.api.exceptions.factories.ExceptionFactory;
 import com.taboola.rest.api.internal.StringResponseFactories;
+import com.taboola.rest.api.model.HttpLoggingLevel;
 import com.taboola.rest.api.model.RequestHeader;
 
 /**
@@ -27,11 +28,12 @@ public class CommunicationConfig {
     private final ExceptionFactory exceptionFactory;
     private final ObjectMapper objectMapper;
     private final StringResponseFactories stringResponseFactories;
+    private final HttpLoggingLevel loggingLevel;
 
     public CommunicationConfig(String baseUrl, Long connectionTimeoutMillis, Long readTimeoutMillis,
                                Long writeTimeoutMillis, Integer maxIdleConnections, Long keepAliveDurationMillis,
                                Collection<RequestHeader> headers, boolean debug, ExceptionFactory exceptionFactory,
-                               ObjectMapper objectMapper, StringResponseFactories stringResponseFactories) {
+                               ObjectMapper objectMapper, StringResponseFactories stringResponseFactories, HttpLoggingLevel loggingLevel) {
         this.baseUrl = baseUrl;
         this.connectionTimeoutMillis = connectionTimeoutMillis;
         this.readTimeoutMillis = readTimeoutMillis;
@@ -43,6 +45,7 @@ public CommunicationConfig(String baseUrl, Long connectionTimeoutMillis, Long re
         this.exceptionFactory = exceptionFactory;
         this.objectMapper = objectMapper;
         this.stringResponseFactories = stringResponseFactories;
+        this.loggingLevel = loggingLevel;
     }
 
     public String getBaseUrl() {
@@ -89,6 +92,10 @@ public StringResponseFactories getStringResponseFactories() {
         return stringResponseFactories;
     }
 
+    public HttpLoggingLevel getLoggingLevel() {
+        return loggingLevel;
+    }
+
     @Override
     public String toString() {
         return "CommunicationConfig{" +
@@ -103,6 +110,7 @@ public String toString() {
                 ", exceptionFactory=" + exceptionFactory +
                 ", objectMapper=" + objectMapper +
                 ", stringResponseFactories=" + stringResponseFactories +
+                ", loggingLevel=" + loggingLevel +
                 '}';
     }
 }

src/main/java/com/taboola/rest/api/model/HttpLoggingLevel.java

@@ -0,0 +1,9 @@
+package com.taboola.rest.api.model;
+
+public enum HttpLoggingLevel {
+
+    NONE,
+    BASIC,
+    HEADERS,
+    BODY;
+}

src/test/java/com/taboola/rest/api/internal/CommunicationFactoryTest.java

@@ -11,7 +11,9 @@
 import com.taboola.rest.api.exceptions.factories.DefaultExceptionFactory;
 import com.taboola.rest.api.internal.config.CommunicationConfig;
 import com.taboola.rest.api.internal.config.UserAgentHeader;
+import com.taboola.rest.api.model.HttpLoggingLevel;
 
+import okhttp3.logging.HttpLoggingInterceptor;
 import retrofit2.http.GET;
 import retrofit2.http.Header;
 import retrofit2.http.Headers;
@@ -37,7 +39,7 @@ public void beforeTest() {
         CommunicationConfig communicationConfig = new CommunicationConfig("http://localhost",
                 1L, 1L, 1L, 1, 60L,
                 Collections.singleton(new UserAgentHeader("Dummy-Agent")),true, new DefaultExceptionFactory(),
-                new ObjectMapper(), new StringResponseFactories());
+                new ObjectMapper(), new StringResponseFactories(), HttpLoggingLevel.BASIC);
         testInstance = new CommunicationFactory(communicationConfig);
     }