Create default HttpClientFactory for integration test

Question

I have a typed client which I want to register as a singleton:

public class SomeHttpClient
{
    private readonly IHttpClientFactory _clientFactory;

    public SomeHttpClient(IHttpClientFactory clientFactory)
    {
        _clientFactory = clientFactory;
    }

    public Task MakeSomeCallAsync(...)
    {
        var client = _clientFactory.Create();
        // Do more stuff
    }
}

The typed client must be a singleton, because it has some circuit breaker logic which breaks the circuit if the API is rate limiting the client. The circuit must be broken across the entire application and obviously not just the current request pipeline (otherwise the client is going to keep hitting the API which is already rate limiting from other instances). This is already implemented by using a typed client which encapsulates that functionality (not Polly though).

Now because the typed client is going to be a singleton we can't inject a single HttpClient because that would bring all the problems we had before with a single long living HttpClient. The obvious solution is to inject a HttpClientFactory which now can be used to issue a HttpClient instance every time the typed client needs one without having to worry about lifetime management etc, since that has been deferred to the HttpClientFactory now.

My question now is how can I create a default HttpClientFactory for a simple functional integration test where I want to instantiate a typed client and see if I can hit the API and get a successful response from an automated test?

I don't want to set up an ASP.NET Core TestServer and a whole application around it because that's an overkill for the sort of functional testing I want to do as this point.

There is no public constructor which I can use for injecting a HttpClientFactory?

Why can't you define and use your own httpclient factory interface? — jgauffin
– jgauffin, Commented Jul 11, 2022 at 11:54

marsze · Accepted Answer · 2024-07-10 09:26:38Z

29

Here's an implementation that will return a new HttpClient instance for each call (just as the interface contract specifies), but re-uses the same HttpMessageHandler (similar to what the real HttpClientFactory does):

public sealed class DefaultHttpClientFactory : IHttpClientFactory, IDisposable
{
    private readonly Lazy<HttpMessageHandler> _handlerLazy = new (() => new HttpClientHandler());

    public HttpClient CreateClient(string name) => new (_handlerLazy.Value, disposeHandler: false);

    public void Dispose()
    {
        if (_handlerLazy.IsValueCreated)
        {
            _handlerLazy.Value.Dispose();
        }
    }
}

edited Jul 10, 2024 at 9:26

answered Jul 29, 2020 at 13:57

marsze

17.5k6 gold badges59 silver badges67 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Steven J Over a year ago

for singleton you need to put DefaultHttpClientFactory default constructor explicetely to private

Steven J Over a year ago

this is what i meant this is not a singleton :) either you put private constructor and set CreateClient static or if you prefer like you did virtual method then no need to set static the lazy instance and manage lifetime of object DefaultHttpClientFactory then in a object container

Steven J Over a year ago

Yop what I meant by using object container which usually does dependency injection

mountain traveller · Accepted Answer · 2019-01-24 21:11:17Z

My question now is how can I create a default HttpClientFactory for a simple functional integration test where I want to instantiate a typed client and see if I can hit the API and get a successful response from an automated test?

Your test can take the exact code that you use to configure the HttpClientFactory in StartUp (this is an example using a Polly policy, but it could be any configuration on HttpClientFactory).

IServiceCollection services = new ServiceCollection(); // [1]

services.AddHttpClient(TestClient)
    .AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError()
    .RetryAsync(3); // [2]

Line [2] could be the exact code from your StartUp class. You could factor it out of the normal ConfigureServices(...) method to a separate static method which your test can also call - so your test tests exactly what StartUp configures.

Then in the test just:

IHttpClientFactory factory = services
    .BuildServiceProvider()
    .GetRequiredService<IHttpClientFactory>();

var sut = new SomeHttpClient(factory);

Stephen Kennedy · Accepted Answer · 2018-09-30 14:06:23Z

10

I just create one myself for testing (I thought there's perhaps already a method that could do that for me):

type DefaultHttpClientFactory() =
    interface IHttpClientFactory with
        member __.CreateClient (name) =
            new HttpClient()

edited Sep 30, 2018 at 14:06

Stephen Kennedy

21.8k24 gold badges99 silver badges114 bronze badges

answered Sep 30, 2018 at 9:16

dustinmoris

3,3813 gold badges29 silver badges36 bronze badges

4 Comments

Pavel Voronin Over a year ago

Come on, F# is a cheat! Comparing with C# verbosity =)

ghostJago Over a year ago

For me, this is a great answer (if you convert back to C#) as I actually want to send data as part of my integration testing. Using this method you have full control. Very Nice!

Vida Over a year ago

Could someone actually convert that code back to C# please?

Lee Benson Over a year ago

Literally just: public class DefaultHttpClientFactory : IHttpClientFactory { public HttpClient CreateClient(string name) { return new HttpClient(); } }

Collectives™ on Stack Overflow

Create default HttpClientFactory for integration test

3 Answers 3

3 Comments

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related