org.sonar.plugins.csharp.S6420.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-csharp-plugin Show documentation

Code Analyzer for C#

There is a newer version: 10.2.0.105762

Why is this an issue?
To avoid holding more connections than necessary and to avoid potentially exhausting the number of available sockets when using
HttpClient, DocumentClient, QueueClient, ConnectionMultiplexer or Azure Storage clients,
consider:

   Creating a single, thread-safe static client that every Azure Function invocation can use. Provide it in a shared class when different Azure
  Functions need it. 
   Instantiate the client as a thread-safe Singleton or a pool of reusable instances and use it with dependency injection. 

These classes typically manage their own connections to the resource, and thus are intended to be instantiated once and reused throughout the
lifetime of an application.
Noncompliant code example
    public class HttpExample
    {
        [FunctionName("HttpExample")]
        public async Task<IActionResult> Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = null)] HttpRequest request)
        {
            HttpClient httpClient = new HttpClient(); // Noncompliant

            var response = await httpClient.GetAsync("https://example.com");
            // rest of the function
        }
    }

Compliant solution
    public class HttpExample
    {
        [FunctionName("HttpExample")]
        public async Task<IActionResult> Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = null)] HttpRequest request, IHttpClientFactory clientFactory)
        {
            var httpClient = clientFactory.CreateClient();
            var response = await httpClient.GetAsync("https://example.com");
            // rest of the function
        }
    }

Resources

   Manage connections in Azure
  Functions: Static Clients 
   Azure Functions -
  Dependency Injection: Service Lifetimes 
   Improper Instantiation antipattern