fix(logging): fix null object reference without logging configured (#70)

Author: hamzamahmood

APIMatic.Core.Test/TestBase.cs

@@ -6,6 +6,7 @@
 using APIMatic.Core.Test.MockTypes.Authentication;
 using APIMatic.Core.Types;
 using APIMatic.Core.Utilities.Logger.Configuration;
+using Microsoft.Extensions.Logging.Abstractions;
 using RichardSzalay.MockHttp;
 
 namespace APIMatic.Core.Test
@@ -55,7 +56,7 @@ protected enum MockServer { Server1, Server2 }
                 ("{language}", "my lang"),
                 ("{version}", "1.*.*")
             })
-            .LoggingConfig(SdkLoggingConfiguration.Default())
+            .LoggingConfig(null)
             .ApiCallback(ApiCallBack)
             .Build()
         );

APIMatic.Core.Test/Utilities/Logger/RequestTest.cs

@@ -19,7 +19,8 @@ public void LogRequest_NotConfigured_NoLogSent()
             var logger = new TestLogger();
             var loggingConfiguration = LoggerHelper.GetSdkLoggingConfiguration(logger: NullLogger.Instance);
             var sdkLogger = new SdkLogger(loggingConfiguration);
-            var request = new CoreRequest(HttpMethod.Post, "https://example.com/api/resource", null, null, null);
+            var request = new CoreRequest(HttpMethod.Post, "https://example.com/api/resource",
+                new Dictionary<string, string>(), null, null);
 
             // Act
             sdkLogger.LogRequest(request);

APIMatic.Core/ApiCall.cs

@@ -36,7 +36,7 @@ public class ApiCall<Request, Response, Context, ApiException, ReturnType, Respo
         private readonly Func<Response, ResponseType, ReturnType> returnTypeCreator;
         private Enum apiCallServer;
         private RequestBuilder requestBuilder;
-        private readonly SdkLogger _sdkLogger;
+        private readonly ISdkLogger _sdkLogger;
 
         /// <summary>
         /// Creates a new instance of ApiCall
@@ -54,7 +54,7 @@ public ApiCall(GlobalConfiguration configuration, ICompatibilityFactory<Request,
             arraySerialization = serialization;
             this.returnTypeCreator = returnTypeCreator;
             responseHandler = new ResponseHandler<Request, Response, Context, ApiException, ResponseType>(compatibility, globalErrors);
-            _sdkLogger = new SdkLogger(configuration.SdkLoggingConfiguration);
+            _sdkLogger = SdkLoggerFactory.Create(configuration.SdkLoggingConfiguration);
         }
 
         /// <summary>

APIMatic.Core/Utilities/Logger/Configuration/SdkLoggingConfiguration.cs

@@ -22,7 +22,7 @@ public class SdkLoggingConfiguration
         /// <summary>
         /// Gets or sets whether sensitive headers should be masked in logs.
         /// </summary>
-        public bool MaskSensitiveHeaders { get; } 
+        public bool MaskSensitiveHeaders { get; }
 
         /// <summary>
         /// Gets or sets the configuration for request logging.
@@ -34,11 +34,6 @@ public class SdkLoggingConfiguration
         /// </summary>
         public ResponseLoggingConfiguration ResponseLoggingConfiguration { get; }
 
-        /// <summary>
-        /// Gets a value indicating whether the logging configuration is fully set up.
-        /// </summary>
-        public bool IsConfigured => Logger != NullLogger.Instance;
-
         private SdkLoggingConfiguration(ILogger logger, LogLevel? logLevel, bool maskSensitiveHeaders,
             RequestLoggingConfiguration requestLoggingConfiguration,
             ResponseLoggingConfiguration responseLoggingConfiguration)
@@ -49,19 +44,12 @@ private SdkLoggingConfiguration(ILogger logger, LogLevel? logLevel, bool maskSen
             RequestLoggingConfiguration = requestLoggingConfiguration;
             ResponseLoggingConfiguration = responseLoggingConfiguration;
         }
-        
-
-        public static SdkLoggingConfiguration Default() =>
-            new SdkLoggingConfiguration(NullLogger.Instance, null, true,
-                RequestLoggingConfiguration.Default(),
-                ResponseLoggingConfiguration.Default());
 
         public static SdkLoggingConfiguration Console() =>
             new SdkLoggingConfiguration(ConsoleLogger.Instance, null, true,
                 RequestLoggingConfiguration.Default(),
                 ResponseLoggingConfiguration.Default());
 
-
         public static SdkLoggingConfiguration Builder(ILogger logger, LogLevel? logLevel, bool maskSensitiveHeaders,
             RequestLoggingConfiguration requestLoggingConfiguration,
             ResponseLoggingConfiguration responseLoggingConfiguration)

APIMatic.Core/Utilities/Logger/ConsoleLogger.cs

@@ -14,8 +14,7 @@ public class ConsoleLogger : ILogger
         /// Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" />.
         /// </summary>
         public static ConsoleLogger Instance { get; } = new ConsoleLogger();
-
-
+        
         /// <summary>
         /// Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" /> class.
         /// </summary>

APIMatic.Core/Utilities/Logger/ISdkLogger.cs

@@ -0,0 +1,19 @@
+using APIMatic.Core.Types.Sdk;
+
+namespace APIMatic.Core.Utilities.Logger
+{
+    internal interface ISdkLogger
+    {
+        /// <summary>
+        /// Logs the details of a request.
+        /// </summary>
+        /// <param name="request">The request to be logged.</param>
+        void LogRequest(CoreRequest request);
+
+        /// <summary>
+        /// Logs the details of a response.
+        /// </summary>
+        /// <param name="response">The response to be logged.</param>
+        void LogResponse(CoreResponse response);
+    }
+}

APIMatic.Core/Utilities/Logger/NullSdkLogger.cs

@@ -0,0 +1,17 @@
+using APIMatic.Core.Types.Sdk;
+
+namespace APIMatic.Core.Utilities.Logger
+{
+    internal class NullSdkLogger : ISdkLogger
+    {
+        public void LogRequest(CoreRequest request)
+        {
+            // Method intentionally left empty.
+        }
+
+        public void LogResponse(CoreResponse response)
+        {
+            // Method intentionally left empty.
+        }
+    }
+}

APIMatic.Core/Utilities/Logger/SdkLogger.cs

@@ -9,13 +9,12 @@ namespace APIMatic.Core.Utilities.Logger
     /// <summary>
     /// Provides logging functionality for SDK operations.
     /// </summary>
-    internal class SdkLogger
+    internal class SdkLogger : ISdkLogger
     {
         private readonly ILogger _logger;
         private readonly Func<LogLevel, LogLevel> _getOverridenLogLevel;
         private readonly RequestLoggingConfiguration _requestConfiguration;
         private readonly ResponseLoggingConfiguration _responseConfiguration;
-        private readonly bool _isConfigured;
         private readonly bool _maskSensitiveHeaders;
 
         /// <summary>
@@ -28,7 +27,6 @@ public SdkLogger(SdkLoggingConfiguration loggingConfiguration)
             _getOverridenLogLevel = level => loggingConfiguration.LogLevel.GetValueOrDefault(level);
             _requestConfiguration = loggingConfiguration.RequestLoggingConfiguration;
             _responseConfiguration = loggingConfiguration.ResponseLoggingConfiguration;
-            _isConfigured = loggingConfiguration.IsConfigured;
             _maskSensitiveHeaders = loggingConfiguration.MaskSensitiveHeaders;
         }
 
@@ -38,7 +36,6 @@ public SdkLogger(SdkLoggingConfiguration loggingConfiguration)
         /// <param name="request">The request to be logged.</param>
         public void LogRequest(CoreRequest request)
         {
-            if (!_isConfigured) return;
             var localLogLevel = _getOverridenLogLevel(LogLevel.Information);
             var contentTypeHeader = request.Headers.GetContentType();
             var url = _requestConfiguration.IncludeQueryInPath ? request.QueryUrl : ParseQueryPath(request.QueryUrl);
@@ -66,7 +63,6 @@ public void LogRequest(CoreRequest request)
         /// <param name="response">The response to be logged.</param>
         public void LogResponse(CoreResponse response)
         {
-            if (!_isConfigured) return;
             var localLogLevel = _getOverridenLogLevel(LogLevel.Information);
             var contentTypeHeader = response.Headers.GetContentType();
             var contentLengthHeader = response.Headers.GetContentLength();

APIMatic.Core/Utilities/Logger/SdkLoggingFactory.cs

@@ -0,0 +1,12 @@
+using APIMatic.Core.Utilities.Logger.Configuration;
+
+namespace APIMatic.Core.Utilities.Logger
+{
+    internal static class SdkLoggerFactory
+    {
+        public static ISdkLogger Create(SdkLoggingConfiguration sdkLoggingConfiguration) =>
+            sdkLoggingConfiguration == null
+                ? (ISdkLogger)new NullSdkLogger()
+                : new SdkLogger(sdkLoggingConfiguration);
+    }
+}