feat(logging): update the current logging implementation (#94)

adds support for structured logging in API calls

Author: hamzamahmood

README.md

@@ -54,7 +54,7 @@
 		<dependency>
 			<groupId>io.apimatic</groupId>
 			<artifactId>core-interfaces</artifactId>
-			<version>[0.2, 0.3)</version>
+			<version>[0.3, 0.4)</version>
 		</dependency>
 		<dependency>
 			<groupId>junit</groupId>
@@ -96,7 +96,7 @@
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>2.0.7</version>
+			<version>2.0.10</version>
 		</dependency>
 		<dependency>
 			<groupId>org.jacoco</groupId>

pom.xml

@@ -3,12 +3,15 @@
 import java.io.IOException;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
+
 import io.apimatic.core.configurations.http.request.EndpointConfiguration;
+import io.apimatic.core.logger.SdkLoggerFactory;
 import io.apimatic.core.request.async.AsyncExecutor;
 import io.apimatic.core.types.CoreApiException;
 import io.apimatic.coreinterfaces.http.request.Request;
 import io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration;
 import io.apimatic.coreinterfaces.http.response.Response;
+import io.apimatic.coreinterfaces.logger.ApiLogger;
 
 /**
  * An API call, or API request, is a message sent to a server asking an API to provide a service or
@@ -38,6 +41,12 @@ public final class ApiCall<ResponseType, ExceptionType extends CoreApiException>
      */
     private final CoreEndpointConfiguration endpointConfiguration;
 
+    /**
+     * An instance of {@link ApiLogger} for logging.
+     */
+    private final ApiLogger apiLogger;
+
+
     /**
      * ApiCall constructor.
      * @param globalConfig the required configuration to built the ApiCall.
@@ -52,6 +61,7 @@ private ApiCall(final GlobalConfiguration globalConfig, final Request coreHttpRe
         this.request = coreHttpRequest;
         this.responseHandler = responseHandler;
         this.endpointConfiguration = coreEndpointConfiguration;
+        this.apiLogger = SdkLoggerFactory.getLogger(globalConfig.getLoggingConfiguration());
     }
 
     /**
@@ -61,8 +71,11 @@ private ApiCall(final GlobalConfiguration globalConfig, final Request coreHttpRe
      * @throws ExceptionType Represents error response from the server.
      */
     public ResponseType execute() throws IOException, ExceptionType {
-        Response httpResponse =
-                globalConfig.getHttpClient().execute(request, endpointConfiguration);
+        apiLogger.logRequest(request);
+        Response httpResponse = globalConfig.getHttpClient()
+            .execute(request, endpointConfiguration);
+        apiLogger.logResponse(httpResponse);
+
         return responseHandler.handle(request, httpResponse, globalConfig, endpointConfiguration);
     }
 
@@ -75,7 +88,7 @@ public CompletableFuture<ResponseType> executeAsync() {
                 request -> globalConfig.getHttpClient().executeAsync(request,
                         endpointConfiguration),
                 (httpRequest, httpResponse) -> responseHandler.handle(httpRequest, httpResponse,
-                        globalConfig, endpointConfiguration));
+                        globalConfig, endpointConfiguration), apiLogger);
     }
 
     /**

src/main/java/io/apimatic/core/ApiCall.java

@@ -6,12 +6,15 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
+
+import io.apimatic.core.logger.configurations.SdkLoggingConfiguration;
 import io.apimatic.core.utilities.CoreHelper;
 import io.apimatic.coreinterfaces.authentication.Authentication;
 import io.apimatic.coreinterfaces.compatibility.CompatibilityFactory;
 import io.apimatic.coreinterfaces.http.Callback;
 import io.apimatic.coreinterfaces.http.HttpClient;
 import io.apimatic.coreinterfaces.http.HttpHeaders;
+import io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration;
 
 /**
  * A class which hold the global configuration properties to make a successful Api Call
@@ -62,6 +65,11 @@ public final class GlobalConfiguration {
      */
     private Function<String, String> baseUri;
 
+    /***
+     * An instance of {@link LoggingConfiguration}
+     */
+    private LoggingConfiguration loggingConfiguration;
+
     /**
      * A private constructor.
      * @param compatibilityFactory
@@ -73,12 +81,14 @@ public final class GlobalConfiguration {
      * @param globalHeaders
      * @param additionalHeaders
      * @param baseUri
+     * @param loggingConfiguration
      */
     private GlobalConfiguration(final CompatibilityFactory compatibilityFactory,
             final String userAgent, final Map<String, String> userAgentConfig,
             final Map<String, Authentication> authentications, final Callback callback,
             final HttpClient httpClient, final Map<String, List<String>> globalHeaders,
-            final HttpHeaders additionalHeaders, final Function<String, String> baseUri) {
+            final HttpHeaders additionalHeaders, final Function<String, String> baseUri,
+            final LoggingConfiguration loggingConfiguration) {
         this.compatibilityFactory = compatibilityFactory;
         this.userAgent = userAgent;
         this.userAgentConfig = userAgentConfig;
@@ -88,6 +98,7 @@ private GlobalConfiguration(final CompatibilityFactory compatibilityFactory,
         this.globalHeaders = globalHeaders != null ? globalHeaders : new HashMap<>();
         this.additionalHeaders = additionalHeaders;
         this.baseUri = baseUri;
+        this.loggingConfiguration = loggingConfiguration;
 
         if (this.userAgent != null) {
             this.userAgent = CoreHelper.updateUserAgent(userAgent, userAgentConfig);
@@ -158,6 +169,13 @@ public Function<String, String> getBaseUri() {
         return baseUri;
     }
 
+    /***
+     * @return Logging configuration for Logger
+     */
+    public LoggingConfiguration getLoggingConfiguration() {
+        return loggingConfiguration;
+    }
+
     public static class Builder {
         /**
          * An instance of {@link CompatibilityFactory}.
@@ -204,6 +222,12 @@ public static class Builder {
          */
         private Function<String, String> baseUri;
 
+        /***
+         * An instance of {@link LoggingConfiguration}
+         */
+        private LoggingConfiguration loggingConfiguration =
+            new SdkLoggingConfiguration.Builder().build();
+
         /**
          * @param compatibilityFactory value for CompatibilityFactor.
          * @return Builder.
@@ -293,14 +317,23 @@ public Builder baseUri(Function<String, String> baseUri) {
             return this;
         }
 
+        /**
+         * @param config Logging configuration for Logger
+         * @return Builder
+         */
+        public Builder loggingConfiguration(LoggingConfiguration config) {
+            this.loggingConfiguration = config;
+            return this;
+        }
+
         /**
          * Builds a new {@link GlobalConfiguration} object using the set fields.
          * @return {@link GlobalConfiguration}.
          */
         public GlobalConfiguration build() {
             return new GlobalConfiguration(compatibilityFactory, userAgent, userAgentConfig,
                     authentications, callback, httpClient, globalHeaders, additionalheaders,
-                    baseUri);
+                    baseUri, loggingConfiguration);
         }
     }
 

src/main/java/io/apimatic/core/GlobalConfiguration.java

@@ -45,7 +45,7 @@ public final class HttpRequest {
     /**
      * A StringBuilder.
      */
-    private final StringBuilder urlBuilder;
+    private final StringBuilder queryUrlBuilder;
 
     /**
      * An instance of {@link CompatibilityFactory}.
@@ -79,7 +79,7 @@ private HttpRequest(final GlobalConfiguration coreConfig, final String server,
             final ArraySerializationFormat arraySerializationFormat) throws IOException {
         this.coreConfig = coreConfig;
         this.compatibilityFactory = coreConfig.getCompatibilityFactory();
-        urlBuilder = getStringBuilder(server, path);
+        queryUrlBuilder = getStringBuilder(server, path, queryParams, arraySerializationFormat);
 
         processTemplateParams(templateParams);
         Object bodyValue = buildBody(body, bodySerializer, bodyParameters);
@@ -103,11 +103,11 @@ private Request buildRequest(
             Map<String, Object> queryParams, List<SimpleEntry<String, Object>> formFields,
             ArraySerializationFormat arraySerializationFormat) throws IOException {
         if (body != null) {
-            return compatibilityFactory.createHttpRequest(httpMethod, urlBuilder, headerParams,
+            return compatibilityFactory.createHttpRequest(httpMethod, queryUrlBuilder, headerParams,
                     queryParams, body);
         }
 
-        return compatibilityFactory.createHttpRequest(httpMethod, urlBuilder, headerParams,
+        return compatibilityFactory.createHttpRequest(httpMethod, queryUrlBuilder, headerParams,
                 queryParams, formFields);
     }
 
@@ -150,13 +150,22 @@ private List<SimpleEntry<String, Object>> generateFormFields(
         return CoreHelper.prepareFormFields(formParameters, arraySerializationFormat);
     }
 
-    private StringBuilder getStringBuilder(String server, String path) {
-        return new StringBuilder(coreConfig.getBaseUri().apply(server) + path);
+    private StringBuilder getStringBuilder(String server, String path,
+            Map<String, Object> queryParams,
+            ArraySerializationFormat arraySerializationFormat) {
+
+        StringBuilder urlBuilder = new StringBuilder(coreConfig.getBaseUri().apply(server) + path);
+
+        // set query parameters
+        CoreHelper.appendUrlWithQueryParameters(urlBuilder, queryParams,
+                arraySerializationFormat);
+
+        return new StringBuilder(CoreHelper.cleanUrl(urlBuilder));
     }
 
     private void processTemplateParams(Map<String, SimpleEntry<Object, Boolean>> templateParams) {
         if (!templateParams.isEmpty()) {
-            CoreHelper.appendUrlWithTemplateParameters(urlBuilder, templateParams);
+            CoreHelper.appendUrlWithTemplateParameters(queryUrlBuilder, templateParams);
         }
     }