Use option monitor for configurating global and specific usages

Author: AmirhosseinEnayati

examples/HttpClientToCurl.Sample.InGlobal/Program.cs

@@ -1,16 +1,9 @@
-using HttpClientToCurl.Config.Others;
 using static HttpClientToCurl.Extensions.ServiceCollectionExtensions;
 
 var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddControllers();
-builder.Services.AddHttpClientToCurl(config =>
-{
-    config.ShowMode = ShowMode.Console | ShowMode.File;
-    config.NeedAddDefaultHeaders = true;
-    config.ConsoleEnableCodeBeautification = true;
-    config.FileConfigPath = "C:\\Users\\Public";
-    config.FileConfigFileName = "curl_commands";
-});
+
+builder.Services.AddHttpClientToCurlInGeneralMode(builder.Configuration);
 builder.Services.AddHttpClient();
 
 var app = builder.Build();

examples/HttpClientToCurl.Sample.InGlobal/appsettings.json

@@ -5,5 +5,23 @@
       "Microsoft.AspNetCore": "Warning"
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "HttpClientToCurl": {
+    "TurnOnAll": true,
+
+    "ShowOnConsole": {
+      "TurnOn": true, //CAUTION: It will be applied when TurnOnAll is 'true'
+      "NeedAddDefaultHeaders": true,
+      "EnableCompression": false,
+      "EnableCodeBeautification": true
+    },
+
+    "SaveToFile": {
+      "TurnOn": true, //CAUTION: It will be applied when TurnOnAll is 'true'
+      "NeedAddDefaultHeaders": true,
+      "EnableCompression": false,
+      "Filename": "curl_commands",
+      "Path": "C:\\Users\\Public"
+    }
+  }
 }

examples/HttpClientToCurl.Sample.InSpecific/Controllers/MyController.cs

@@ -9,8 +9,19 @@ public class MyController(IHttpClientFactory httpClientFactory) : ControllerBase
 {
     private readonly IHttpClientFactory _httpClientFactory = httpClientFactory;
 
-    [HttpGet]
+    [HttpGet("send-and-show-curl")]
+    public async Task SendAndShowCurl()
+    {
+        await SendRemoteRequest("my-client1");
+    }
+
+    [HttpGet("send")]
     public async Task Send()
+    {
+        await SendRemoteRequest("my-client2");
+    }
+
+    private async Task SendRemoteRequest(string httpClientName)
     {
         string apiUrl = "https://jsonplaceholder.typicode.com/posts";
 
@@ -34,7 +45,7 @@ public async Task Send()
             // Use it to check and compare against all the requirements.
 
             // Send the request
-            HttpResponseMessage response = await _httpClientFactory.CreateClient("my-client").SendAsync(request);
+            HttpResponseMessage response = await _httpClientFactory.CreateClient(httpClientName).SendAsync(request);
 
             // Check if the request was successful (status code 200-299)
             if (response.IsSuccessStatusCode)

examples/HttpClientToCurl.Sample.InSpecific/Program.cs

@@ -1,19 +1,11 @@
-using HttpClientToCurl.Config.Others;
-using HttpClientToCurl.HttpMessageHandlers;
 using static HttpClientToCurl.Extensions.ServiceCollectionExtensions;
 
 var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddControllers();
-builder.Services.AddHttpClientToCurl(config =>
-{
-    config.ShowMode = ShowMode.Console | ShowMode.File;
-    config.NeedAddDefaultHeaders = true;
-    config.ConsoleEnableCodeBeautification = true;
-    config.FileConfigPath = "C:\\Users\\Public";
-    config.FileConfigFileName = "curl_commands";
-}, false);
-builder.Services.AddHttpClient("my-client")
-                .AddHttpMessageHandler<CurlGeneratorHttpMessageHandler>();
+
+builder.Services.AddHttpClientToCurl(builder.Configuration);
+builder.Services.AddHttpClient("my-client1", showCurl: true);
+builder.Services.AddHttpClient("my-client2");
 
 var app = builder.Build();
 

examples/HttpClientToCurl.Sample.InSpecific/appsettings.json

@@ -5,5 +5,23 @@
       "Microsoft.AspNetCore": "Warning"
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "HttpClientToCurl": {
+    "TurnOnAll": true,
+
+    "ShowOnConsole": {
+      "TurnOn": true, //CAUTION: It will be applied when TurnOnAll is 'true'
+      "NeedAddDefaultHeaders": true,
+      "EnableCompression": false,
+      "EnableCodeBeautification": true
+    },
+
+    "SaveToFile": {
+      "TurnOn": true, //CAUTION: It will be applied when TurnOnAll is 'true'
+      "NeedAddDefaultHeaders": true,
+      "EnableCompression": false,
+      "Filename": "curl_commands",
+      "Path": "C:\\Users\\Public"
+    }
+  }
 }

src/HttpClientToCurl/Config/CompositConfig.cs

@@ -0,0 +1,21 @@
+namespace HttpClientToCurl.Config;
+
+public sealed class CompositConfig
+{
+    /// <summary>
+    /// Set true to create curl output; false to disable it.  <c>Default is true</c>. 
+    /// </summary>
+    public bool TurnOnAll { get; set; } = true;
+
+    /// <summary>
+    /// Set true to show curl on the console; false to disable it. <c>Default is true</c>.
+    /// <para>If TurnOnAll is set to false, it will be ignored.</para>
+    /// </summary>
+    public ConsoleConfig ShowOnConsole { get; set; }
+
+    /// <summary>
+    /// Set true to save the curl file; false to disable it. <c>Default is true</c>.
+    /// <para>If TurnOnAll is set to false, it will be ignored.</para>
+    /// </summary>
+    public FileConfig SaveToFile { get; set; }
+}

src/HttpClientToCurl/Config/GlobalConfig.cs

@@ -1,6 +1,6 @@
 using HttpClientToCurl.Config;
-using HttpClientToCurl.Config.Others;
 using HttpClientToCurl.HttpMessageHandlers;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Http;
 
@@ -9,27 +9,44 @@ namespace HttpClientToCurl.Extensions;
 public static class ServiceCollectionExtensions
 {
     /// <summary>
-    /// Generating curl script of all HTTP requests.
+    /// Generating curl script for all HTTP requests.
     /// <para> By default, show it in the IDE console. </para>
     /// </summary>
-    /// <param name="configAction">Optional</param>
-    /// <param name="isGlobal">Apply for all http requests in the application or not. Default is true.</param>
-    public static void AddHttpClientToCurl(
-    this IServiceCollection services,
-    Action<GlobalConfig> configAction = null,
-    bool isGlobal = true)
+    public static void AddHttpClientToCurlInGeneralMode(
+           this IServiceCollection services,
+           IConfiguration configuration)
     {
-        configAction ??= config => config.ShowMode = ShowMode.Console;
+        AddServices(services, configuration);
+        services.Add(ServiceDescriptor.Transient<IHttpMessageHandlerBuilderFilter, HttpMessageHandlerAppender>());
+    }
 
-        var config = new GlobalConfig();
-        configAction?.Invoke(config);
+    /// <summary>
+    /// Generating curl script for specific http client 
+    /// </summary>
+    /// <param name="services"></param>
+    /// <param name="configuration"></param>
+    public static void AddHttpClientToCurl(
+           this IServiceCollection services,
+           IConfiguration configuration)
+    {
+        AddServices(services, configuration);
+    }
 
-        services.AddSingleton(config);
-        services.AddTransient<CurlGeneratorHttpMessageHandler>();
+    public static IHttpClientBuilder AddHttpClient(this IServiceCollection services, string name, bool showCurl = false)
+    {
+        var httpClientBuilder = HttpClientFactoryServiceCollectionExtensions.AddHttpClient(services, name);
 
-        if (isGlobal)
+        if (showCurl)
         {
-            services.Add(ServiceDescriptor.Transient<IHttpMessageHandlerBuilderFilter, HttpMessageHandlerAppender>());
+            httpClientBuilder.AddHttpMessageHandler<CurlGeneratorHttpMessageHandler>();
         }
+
+        return httpClientBuilder;
+    }
+
+    private static void AddServices(IServiceCollection services, IConfiguration configuration)
+    {
+        services.Configure<CompositConfig>(configuration.GetSection("HttpClientToCurl"));
+        services.AddTransient<CurlGeneratorHttpMessageHandler>();
     }
 }

src/HttpClientToCurl/Extensions/ServiceCollectionExtensions.cs

@@ -25,6 +25,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.10" />
     <PackageReference Include="Microsoft.Extensions.Http" Version="9.0.10" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="9.0.10" />
   </ItemGroup>
 
 </Project>

src/HttpClientToCurl/HttpClientToCurl.csproj

@@ -1,35 +1,42 @@
 using HttpClientToCurl.Config;
-using HttpClientToCurl.Config.Others;
 using HttpClientToCurl.Extensions;
+using Microsoft.Extensions.Options;
 
 namespace HttpClientToCurl.HttpMessageHandlers;
 
-public class CurlGeneratorHttpMessageHandler(GlobalConfig config) : DelegatingHandler
+public class CurlGeneratorHttpMessageHandler(IOptionsMonitor<CompositConfig> monitorConfig) : DelegatingHandler
 {
+    private readonly IOptionsMonitor<CompositConfig> _monitorConfig = monitorConfig;
+
     protected override Task<HttpResponseMessage> SendAsync(
         HttpRequestMessage httpRequestMessage,
         CancellationToken cancellationToken)
     {
-        if (config.ShowMode.HasFlag(ShowMode.Console))
+        var config = _monitorConfig.CurrentValue;
+        if (config.TurnOnAll)
         {
-            httpRequestMessage.GenerateCurlInConsole(httpRequestMessage.RequestUri, consoleConfig =>
+            if (config.ShowOnConsole.TurnOn)
             {
-                consoleConfig.TurnOn = true;
-                consoleConfig.EnableCodeBeautification = config.ConsoleEnableCodeBeautification;
-                consoleConfig.EnableCompression = config.ConsoleEnableCompression;
-                consoleConfig.NeedAddDefaultHeaders = config.NeedAddDefaultHeaders;
-            });
-        }
+                httpRequestMessage.GenerateCurlInConsole(httpRequestMessage.RequestUri, consoleConfig =>
+                {
+                    consoleConfig.TurnOn = true;
+                    consoleConfig.EnableCodeBeautification = config.ShowOnConsole.EnableCodeBeautification;
+                    consoleConfig.EnableCompression = config.ShowOnConsole.EnableCompression;
+                    consoleConfig.NeedAddDefaultHeaders = config.ShowOnConsole.NeedAddDefaultHeaders;
+                });
+            }
 
-        if (config.ShowMode.HasFlag(ShowMode.File))
-        {
-            httpRequestMessage.GenerateCurlInFile(httpRequestMessage.RequestUri, fileConfig =>
+            if (config.SaveToFile.TurnOn)
             {
-                fileConfig.TurnOn = true;
-                fileConfig.Filename = config.FileConfigFileName;
-                fileConfig.Path = config.FileConfigPath;
-                fileConfig.NeedAddDefaultHeaders = config.NeedAddDefaultHeaders;
-            });
+                httpRequestMessage.GenerateCurlInFile(httpRequestMessage.RequestUri, fileConfig =>
+                {
+                    fileConfig.TurnOn = true;
+                    fileConfig.EnableCompression = config.SaveToFile.EnableCompression;
+                    fileConfig.NeedAddDefaultHeaders = config.SaveToFile.NeedAddDefaultHeaders;
+                    fileConfig.Path = config.SaveToFile.Path;
+                    fileConfig.Filename = config.SaveToFile.Filename;
+                });
+            }
         }
 
         var response = base.SendAsync(httpRequestMessage, cancellationToken);