Merge pull request #65 from yurii-bart/feat/add-injectable-logger

Feat/add injectable logger

Author: r4m-semeyon

route4me-csharp-sdk/Route4MeSDKLibrary/HttpClientHolder.cs

@@ -1,20 +1,29 @@
 using System;
 using System.Net.Http;
 
+using Microsoft.Extensions.Logging;
+
 namespace Route4MeSDKLibrary
 {
     internal class HttpClientHolder : IDisposable
     {
         private readonly string _baseAddress;
 
-        public HttpClientHolder(HttpClient httpClient, string baseAddress)
+        public HttpClientHolder(HttpClient httpClient, string baseAddress, ILogger logger = null)
         {
             HttpClient = httpClient;
             _baseAddress = baseAddress;
+            Logger = logger;
         }
 
         public HttpClient HttpClient { get; }
 
+        /// <summary>
+        ///     Logger instance for this HTTP client holder.
+        ///     Thread-safe as each holder instance has its own logger reference.
+        /// </summary>
+        public ILogger Logger { get; }
+
         public void Dispose()
         {
             HttpClientHolderManager.ReleaseHttpClientHolder(_baseAddress);

route4me-csharp-sdk/Route4MeSDKLibrary/HttpClientHolderManager.cs

@@ -26,19 +26,13 @@ internal class HttpClientHolderManager
         /// </summary>
         public static TimeSpan RequestsTimeout { get; set; } = TimeSpan.FromSeconds(30);
 
-        /// <summary>
-        ///     Static logger for HTTP client connection pooling operations.
-        ///     Thread-safe via SyncRoot lock in all access points.
-        /// </summary>
-        public static ILogger Logger { get; set; }
-
         static HttpClientHolderManager()
         {
             // ReSharper disable once ObjectCreationAsStatement
             new SequentialTimer(OnTimerCallback, TimeSpan.FromHours(2));
         }
 
-        public static HttpClientHolder AcquireHttpClientHolder(string baseAddress, string apiKey = null)
+        public static HttpClientHolder AcquireHttpClientHolder(string baseAddress, string apiKey = null, ILogger logger = null)
         {
             lock (SyncRoot)
             {
@@ -55,7 +49,7 @@ public static HttpClientHolder AcquireHttpClientHolder(string baseAddress, strin
                     HttpClientWrappers.Add(baseAddress, wrapper);
                 }
 
-                return new HttpClientHolder(wrapper.HttpClient, baseAddress);
+                return new HttpClientHolder(wrapper.HttpClient, baseAddress, logger);
             }
         }
 

route4me-csharp-sdk/Route4MeSDKLibrary/Managers/Route4MeManagerBase.cs

@@ -161,13 +161,8 @@ protected async Task<Tuple<T, ResultResponse, string>> GetJsonObjectFromAPIAsync
             try
             {
                 using (var httpClientHolder =
-                       HttpClientHolderManager.AcquireHttpClientHolder(uri.GetLeftPart(UriPartial.Authority), v5 ? ApiKey : null))
+                       HttpClientHolderManager.AcquireHttpClientHolder(uri.GetLeftPart(UriPartial.Authority), v5 ? ApiKey : null, Logger))
                 {
-                    if (Logger != null)
-                    {
-                        HttpClientHolderManager.Logger = Logger;
-                    }
-
                     switch (httpMethod)
                     {
                         case HttpMethodType.Get:
@@ -408,13 +403,8 @@ protected T GetJsonObjectFromAPI<T>(GenericParameters optimizationParameters,
             try
             {
                 using (var httpClientHolder =
-                       HttpClientHolderManager.AcquireHttpClientHolder(uri.GetLeftPart(UriPartial.Authority), v5 ? ApiKey : null))
+                       HttpClientHolderManager.AcquireHttpClientHolder(uri.GetLeftPart(UriPartial.Authority), v5 ? ApiKey : null, Logger))
                 {
-                    if (Logger != null)
-                    {
-                        HttpClientHolderManager.Logger = Logger;
-                    }
-
                     switch (httpMethod)
                     {
                         case HttpMethodType.Get:

route4me-csharp-sdk/Route4MeSDKLibrary/Route4MeManagerV5.cs

@@ -1,8 +1,6 @@
 using System;
 using System.Threading.Tasks;
 
-using Microsoft.Extensions.Logging;
-
 using Route4MeSDK.DataTypes.V5;
 using Route4MeSDK.DataTypes.V5.TelematicsPlatform;
 using Route4MeSDK.QueryTypes.V5;
@@ -56,26 +54,6 @@ public Route4MeManagerV5(string apiKey)
             _locationManager = new LocationManagerV5(apiKey);
             _customerManager = new CustomerManagerV5(apiKey);
             _facilityManager = new FacilityManagerV5(apiKey);
-            _logger = null;
-        }
-
-        public Route4MeManagerV5(string apiKey, ILogger logger)
-        {
-            _logger = logger;
-            _addressBookContactsManager = new AddressBookContactsManagerV5(apiKey, logger);
-            _accountProfileManager = new AccountProfileManagerV5(apiKey, logger);
-            _addressBarcodeManager = new AddressBarcodeManagerV5(apiKey, logger);
-            _teamManagementManager = new TeamManagementManagerV5(apiKey, logger);
-            _driveReviewManager = new DriveReviewManagerV5(apiKey, logger);
-            _routeManager = new RouteManagerV5(apiKey, logger);
-            _optimizationManager = new OptimizationManagerV5(apiKey, logger);
-            _vehicleManager = new VehicleManagerV5(apiKey, logger);
-            _telematicsManager = new TelematicsManagerV5(apiKey, logger);
-            _orderManager = new OrderManagerV5(apiKey, logger);
-            _routeStatusManager = new RouteStatusManagerV5(apiKey, logger);
-            _locationManager = new LocationManagerV5(apiKey, logger);
-            _customerManager = new CustomerManagerV5(apiKey, logger);
-            _facilityManager = new FacilityManagerV5(apiKey, logger);
         }
 
         #endregion
@@ -96,7 +74,6 @@ public Route4MeManagerV5(string apiKey, ILogger logger)
         private readonly LocationManagerV5 _locationManager;
         private readonly CustomerManagerV5 _customerManager;
         private readonly FacilityManagerV5 _facilityManager;
-        private readonly ILogger _logger;
 
         #endregion
 

route4me-csharp-sdk/Route4MeSDKTest/Examples/API5/LoggingExample.cs

@@ -5,13 +5,18 @@
 using Route4MeSDK.DataTypes.V5;
 using Route4MeSDK.QueryTypes.V5;
 
+using Route4MeSDKLibrary.Managers;
+
 namespace Route4MeSDK.Examples
 {
     public sealed partial class Route4MeExamples
     {
         /// <summary>
         /// Example demonstrating how to use Microsoft.Extensions.Logging with Route4Me SDK.
         /// This shows how to inject a logger to capture HTTP requests, responses, and errors.
+        ///
+        /// Note: Logger injection is supported by specialized V5 managers (RouteManagerV5, VehicleManagerV5, etc.)
+        /// that inherit from Route4MeManagerBase. The facade Route4MeManagerV5 does not support logger injection.
         /// </summary>
         public void LoggingExample()
         {
@@ -26,12 +31,14 @@ public void LoggingExample()
             });
 
             // Step 2: Create a logger for Route4Me operations
-            var logger = loggerFactory.CreateLogger<Route4MeManagerV5>();
+            var logger = loggerFactory.CreateLogger<RouteManagerV5>();
 
-            Console.WriteLine("Creating Route4MeManagerV5 with logger...\n");
+            Console.WriteLine("Creating RouteManagerV5 with logger...\n");
 
-            // Step 3: Create Route4MeManagerV5 with logger injection
-            var route4Me = new Route4MeManagerV5(ActualApiKey, logger);
+            // Step 3: Create a specialized manager with logger injection
+            // The logger is passed to the constructor and will be used for all API calls
+            // This is thread-safe - each manager instance has its own logger reference
+            var routeManager = new RouteManagerV5(ActualApiKey, logger);
 
             Console.WriteLine("Making API call - watch for log output below:\n");
             Console.WriteLine("----------------------------------------");
@@ -45,17 +52,24 @@ public void LoggingExample()
 
             try
             {
-                var result = route4Me.GetRoutes(routeParameters, out ResultResponse resultResponse);
+                var result = routeManager.GetRoutes(routeParameters, out ResultResponse resultResponse);
 
                 Console.WriteLine("----------------------------------------\n");
 
                 if (resultResponse.Status)
                 {
-                    Console.WriteLine($"Success! Retrieved {result.Length} routes");
+                    Console.WriteLine($"Success! Retrieved {result?.Length ?? 0} routes");
                 }
                 else
                 {
                     Console.WriteLine("Request failed - check logs for details");
+                    if (resultResponse.Messages != null)
+                    {
+                        foreach (var msg in resultResponse.Messages)
+                        {
+                            Console.WriteLine($"  {msg.Key}: {string.Join(", ", msg.Value)}");
+                        }
+                    }
                 }
             }
             catch (Exception ex)
@@ -64,6 +78,11 @@ public void LoggingExample()
             }
 
             Console.WriteLine("\n=== Logging Example Complete ===");
+            Console.WriteLine("\nTip: You can use different specialized managers with their own loggers:");
+            Console.WriteLine("  - VehicleManagerV5(apiKey, vehicleLogger)");
+            Console.WriteLine("  - OrderManagerV5(apiKey, orderLogger)");
+            Console.WriteLine("  - AddressBookContactsManagerV5(apiKey, contactLogger)");
+            Console.WriteLine("  Each manager instance is thread-safe with its own logger context.");
         }
     }
 }