Last active
October 18, 2024 14:16
-
-
Save davidfowl/c34633f1ddc519f030a1c0c5abe8e867 to your computer and use it in GitHub Desktop.
Header propagation HttpClientFactory middleware
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
public void ConfigureServices(IServiceCollection services) | |
{ | |
services.AddHttpClient("myclient"); | |
// Global header propagation for any HttpClient that comes from HttpClientFactory | |
services.AddHeaderPropagation(options => | |
{ | |
options.HeaderNames.Add("Correlation-Id"); | |
}); | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
using System; | |
using System.Collections.Generic; | |
using System.Net.Http; | |
using System.Threading.Tasks; | |
using Microsoft.AspNetCore.Http; | |
using Microsoft.Extensions.DependencyInjection; | |
using Microsoft.Extensions.DependencyInjection.Extensions; | |
using Microsoft.Extensions.Http; | |
using Microsoft.Extensions.Options; | |
using Microsoft.Extensions.Primitives; | |
namespace HeaderPropagation | |
{ | |
public static class HeaderPropagationExtensions | |
{ | |
public static IServiceCollection AddHeaderPropagation(this IServiceCollection services, Action<HeaderPropagationOptions> configure) | |
{ | |
services.AddHttpContextAccessor(); | |
services.ConfigureAll(configure); | |
services.TryAddEnumerable(ServiceDescriptor.Singleton<IHttpMessageHandlerBuilderFilter, HeaderPropagationMessageHandlerBuilderFilter>()); | |
return services; | |
} | |
public static IHttpClientBuilder AddHeaderPropagation(this IHttpClientBuilder builder, Action<HeaderPropagationOptions> configure) | |
{ | |
builder.Services.AddHttpContextAccessor(); | |
builder.Services.Configure(builder.Name, configure); | |
builder.AddHttpMessageHandler((sp) => | |
{ | |
var options = sp.GetRequiredService<IOptionsMonitor<HeaderPropagationOptions>>(); | |
var contextAccessor = sp.GetRequiredService<IHttpContextAccessor>(); | |
return new HeaderPropagationMessageHandler(options.Get(builder.Name), contextAccessor); | |
}); | |
return builder; | |
} | |
} | |
internal class HeaderPropagationMessageHandlerBuilderFilter : IHttpMessageHandlerBuilderFilter | |
{ | |
private readonly HeaderPropagationOptions _options; | |
private readonly IHttpContextAccessor _contextAccessor; | |
public HeaderPropagationMessageHandlerBuilderFilter(IOptions<HeaderPropagationOptions> options, IHttpContextAccessor contextAccessor) | |
{ | |
_options = options.Value; | |
_contextAccessor = contextAccessor; | |
} | |
public Action<HttpMessageHandlerBuilder> Configure(Action<HttpMessageHandlerBuilder> next) | |
{ | |
return builder => | |
{ | |
builder.AdditionalHandlers.Add(new HeaderPropagationMessageHandler(_options, _contextAccessor)); | |
next(builder); | |
}; | |
} | |
} | |
public class HeaderPropagationOptions | |
{ | |
public IList<string> HeaderNames { get; set; } = new List<string>(); | |
} | |
public class HeaderPropagationMessageHandler : DelegatingHandler | |
{ | |
private readonly HeaderPropagationOptions _options; | |
private readonly IHttpContextAccessor _contextAccessor; | |
public HeaderPropagationMessageHandler(HeaderPropagationOptions options, IHttpContextAccessor contextAccessor) | |
{ | |
_options = options; | |
_contextAccessor = contextAccessor; | |
} | |
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken) | |
{ | |
if (_contextAccessor.HttpContext != null) | |
{ | |
// REVIEW: This logic likely gets more fancy and allows mapping headers in more complex ways | |
foreach (var headerName in _options.HeaderNames) | |
{ | |
// Get the incoming header value | |
var headerValue = _contextAccessor.HttpContext.Request.Headers[headerName]; | |
if (StringValues.IsNullOrEmpty(headerValue)) | |
{ | |
continue; | |
} | |
request.Headers.TryAddWithoutValidation(headerName, (string[])headerValue); | |
} | |
} | |
return base.SendAsync(request, cancellationToken); | |
} | |
} | |
} |
the safest thing would be having your own async local.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hey @davidfowl - we are using the HeaderPropagationMiddleware for header propagation but we now have a situation where we must get a Boolean value from some API (we'd do this in a Middleware) and pass that value as a header to the all HttpClients within that HttpRequest (via a DelegatingHandler).
One (potential naive) naive way of doing this is
value
in a ScopedService.value
and add the custom header.(I believe
Items
property in HttpContext could be used for this but it would still require a IHttpContextAccessor)This works but worried that the usage of IHttpContextAccessor may not be safe as you mention (and as seen in some other online sources). Would you have a recommendation for this use case? Thanks!