Share HttpClient to all plugins preventing Socket exhaustion

tekgator · tekgator · commit 7f11b2f9a8ec · 2023-06-01T13:13:27.000+10:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 
 
+## [1.3.1] - 2023-06-01
+
+### Fixed
+- All plugin share the same (static) HttpClient now if HttpClientFactory is not provided, preventing Socket exhaustion
+
+
 ## [1.3.0] - 2023-06-01
 ### Added
 - Paper plugin flag pre and snapshot builds as IsSnapshot
diff --git a/MinecraftJars.Core/PluginHttpClientFactory.cs b/MinecraftJars.Core/PluginHttpClientFactory.cs
@@ -0,0 +1,46 @@
+using System.Reflection;
+
+namespace MinecraftJars.Core;
+
+public class PluginHttpClientFactory
+{
+    private static readonly object LockObject = new();
+    
+    private readonly IHttpClientFactory? _httpClientFactory;
+    private HttpClient? _httpClient;
+
+    public PluginHttpClientFactory(IHttpClientFactory? httpClientFactory = null)
+    {
+        _httpClientFactory = httpClientFactory;
+    }
+
+    public HttpClient GetClient()
+    {
+        lock (LockObject)
+        {
+            HttpClient client;
+
+            if (_httpClientFactory != null)
+            {
+                client = _httpClientFactory.CreateClient();            
+            }
+            else
+            {
+                _httpClient ??= new HttpClient(new SocketsHttpHandler
+                {
+                    PooledConnectionLifetime = TimeSpan.FromMinutes(15)
+                });
+
+                client = _httpClient;
+            }
+
+            if (!client.DefaultRequestHeaders.UserAgent.Any())
+            {
+                var assembly = Assembly.GetEntryAssembly() ?? Assembly.GetExecutingAssembly();
+                client.DefaultRequestHeaders.UserAgent.TryParseAdd(assembly.GetName().Name);
+            }
+            
+            return client;
+        }
+    }
+}
diff --git a/MinecraftJars.Core/Providers/ProviderOptions.cs b/MinecraftJars.Core/Providers/ProviderOptions.cs
@@ -1,28 +1,10 @@
-﻿using System.Reflection;
-
-namespace MinecraftJars.Core.Providers;
+﻿namespace MinecraftJars.Core.Providers;
 
 public class ProviderOptions
 {
     /// <summary>
-    /// If provided the CreatClient Method is utilized to create a HttpClient
-    /// otherwise a new HttpClient is instantiated by each plugin
+    /// If provided the CreateClient Method is utilized to create a HttpClient
+    /// otherwise a new HttpClient is instantiated by the MinecraftJarManager
     /// </summary>     
     public IHttpClientFactory? HttpClientFactory { get; init; }
-    
-    public HttpClient GetHttpClient()
-    {
-        var client = HttpClientFactory?.CreateClient() ?? new HttpClient(new SocketsHttpHandler
-        {
-            PooledConnectionLifetime = TimeSpan.FromMinutes(15)
-        });
-
-        if (client.DefaultRequestHeaders.UserAgent.Any())
-            return client;
-
-        var assembly = Assembly.GetEntryAssembly() ?? Assembly.GetExecutingAssembly();
-        client.DefaultRequestHeaders.UserAgent.TryParseAdd(assembly.GetName().Name);
-
-        return client;
-    }    
 }
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Fabric/FabricProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Fabric/FabricProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System.ComponentModel.Composition;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Projects;
 using MinecraftJars.Core.Providers;
 using MinecraftJars.Core.Versions;
@@ -9,12 +10,14 @@ namespace MinecraftJars.Plugin.Fabric;
 public class FabricProvider : IMinecraftProvider
 {
     [ImportingConstructor]
-    public FabricProvider(ProviderOptions? options)
+    public FabricProvider(
+        PluginHttpClientFactory httpClientFactory, 
+        ProviderOptions? options)
     {
+        FabricVersionFactory.HttpClientFactory = httpClientFactory;
         ProviderOptions = options ?? new ProviderOptions();
-        FabricVersionFactory.HttpClient = ProviderOptions.GetHttpClient();
     }
-    
+
     public ProviderOptions ProviderOptions { get; }
     public string Name => "Fabric";
     public byte[] Logo => Properties.Resources.Fabric;
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Fabric/FabricVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Fabric/FabricVersionFactory.cs
@@ -1,4 +1,5 @@
 ﻿using System.Net.Http.Json;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Downloads;
 using MinecraftJars.Core.Versions;
 using MinecraftJars.Plugin.Fabric.Model;
@@ -13,7 +14,7 @@ internal static class FabricVersionFactory
     private const string FabricLoaderRequestUri = FabricBaseRequestUri + "/versions/loader/{0}";
     private const string FabricDownloadRequestUri = FabricBaseRequestUri + "/versions/loader/{0}/{1}/{2}/server/jar";    
     
-    public static HttpClient HttpClient { get; set; } = default!;
+    public static PluginHttpClientFactory HttpClientFactory { get; set; } = default!;
     
     public static async Task<List<FabricVersion>> GetVersion(
         string projectName,
@@ -22,7 +23,8 @@ public static async Task<List<FabricVersion>> GetVersion(
     {
         var project = FabricProjectFactory.Projects.Single(p => p.Name.Equals(projectName));
 
-        var versionsApi = await HttpClient.GetFromJsonAsync<Versions>(FabricVersionsRequestUri, cancellationToken) ??
+        var client = HttpClientFactory.GetClient();
+        var versionsApi = await client.GetFromJsonAsync<Versions>(FabricVersionsRequestUri, cancellationToken) ??
             throw new InvalidOperationException("Could not acquire game type details.");
     
         var versions = (from game in versionsApi.Games
@@ -48,7 +50,8 @@ public static async Task<IMinecraftDownload> GetDownload(
         CancellationToken cancellationToken)
     {
         var requestUriCompatibleLoaders = string.Format(FabricLoaderRequestUri, version.Version);
-        var compatibleLoaders = await HttpClient
+        var client = HttpClientFactory.GetClient();
+        var compatibleLoaders = await client
             .GetFromJsonAsync<List<CompatibleLoader>>(requestUriCompatibleLoaders, cancellationToken);
 
         if (compatibleLoaders == null || !compatibleLoaders.Any()) 
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Mohist/MohistProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Mohist/MohistProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System.ComponentModel.Composition;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Projects;
 using MinecraftJars.Core.Providers;
 using MinecraftJars.Core.Versions;
@@ -9,12 +10,14 @@ namespace MinecraftJars.Plugin.Mohist;
 public class MohistProvider : IMinecraftProvider
 {
     [ImportingConstructor]
-    public MohistProvider(ProviderOptions? options)
+    public MohistProvider(
+        PluginHttpClientFactory httpClientFactory, 
+        ProviderOptions? options)
     {
+        MohistVersionFactory.HttpClientFactory = httpClientFactory;
         ProviderOptions = options ?? new ProviderOptions();
-        MohistVersionFactory.HttpClient = ProviderOptions.GetHttpClient();
     }
-    
+
     public ProviderOptions ProviderOptions { get; }
     public string Name => "Mohist";
     public byte[] Logo => Properties.Resources.Mohist;
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Mohist/MohistVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Mohist/MohistVersionFactory.cs
@@ -1,4 +1,5 @@
 ﻿using System.Net.Http.Json;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Downloads;
 using MinecraftJars.Core.Versions;
 using MinecraftJars.Plugin.Mohist.Model;
@@ -11,7 +12,7 @@ internal static class MohistVersionFactory
     private const string MohistVersionRequestUri = "https://mohistmc.com/api/versions";
     private const string MohistLatestBuildRequestUri = "https://mohistmc.com/api/{0}/latest/";
 
-    public static HttpClient HttpClient { get; set; } = default!;
+    public static PluginHttpClientFactory HttpClientFactory { get; set; } = default!;
     
     public static async Task<List<MohistVersion>> GetVersion(
         string projectName,
@@ -20,7 +21,8 @@ public static async Task<List<MohistVersion>> GetVersion(
     {
         var project = MohistProjectFactory.Projects.Single(p => p.Name.Equals(projectName));
 
-        var versionApi = await HttpClient.GetFromJsonAsync<List<string>>(MohistVersionRequestUri, cancellationToken) ??
+        var client = HttpClientFactory.GetClient();
+        var versionApi = await client.GetFromJsonAsync<List<string>>(MohistVersionRequestUri, cancellationToken) ??
             throw new InvalidOperationException("Could not acquire version details.");
     
         versionApi.Reverse();
@@ -42,8 +44,9 @@ public static async Task<IMinecraftDownload> GetDownload(
         MohistVersion version, 
         CancellationToken cancellationToken)
     {
+        var client = HttpClientFactory.GetClient();
         var requestUriLatestBuild = string.Format(MohistLatestBuildRequestUri, version.Version);
-        var latestBuild = await HttpClient.GetFromJsonAsync<Build>(requestUriLatestBuild, cancellationToken);
+        var latestBuild = await client.GetFromJsonAsync<Build>(requestUriLatestBuild, cancellationToken);
 
         if (latestBuild == null || string.IsNullOrWhiteSpace(latestBuild.Url)) 
             throw new InvalidOperationException("Could not acquire download details.");
@@ -54,7 +57,7 @@ public static async Task<IMinecraftDownload> GetDownload(
         if (options.LoadFilesize)
         {
             using var requestMessage = new HttpRequestMessage(HttpMethod.Get, latestBuild.Url);
-            using var httpResponse = await HttpClient.SendAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
+            using var httpResponse = await client.SendAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
 
             if (httpResponse.IsSuccessStatusCode)
             {
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/MojangProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/MojangProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System.ComponentModel.Composition;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Projects;
 using MinecraftJars.Core.Providers;
 using MinecraftJars.Core.Versions;
@@ -9,10 +10,12 @@ namespace MinecraftJars.Plugin.Mojang;
 public class MojangProvider : IMinecraftProvider
 {
     [ImportingConstructor]
-    public MojangProvider(ProviderOptions? options)
+    public MojangProvider(
+        PluginHttpClientFactory httpClientFactory, 
+        ProviderOptions? options)
     {
+        MojangVersionFactory.HttpClientFactory = httpClientFactory;
         ProviderOptions = options ?? new ProviderOptions();
-        MojangVersionFactory.HttpClient = ProviderOptions.GetHttpClient();
     }
 
     public ProviderOptions ProviderOptions { get; }
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/MojangVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/MojangVersionFactory.cs
@@ -2,6 +2,7 @@
 using System.Net.Http.Json;
 using System.Net.Mime;
 using System.Text.RegularExpressions;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Downloads;
 using MinecraftJars.Core.Versions;
 using MinecraftJars.Plugin.Mojang.Models;
@@ -18,7 +19,7 @@ internal static partial class MojangVersionFactory
     private static partial Regex MojangBedrockDownloadLink();
     private const string MojangBedrockRequestUri = "https://www.minecraft.net/download/server/bedrock";
 
-    public static HttpClient HttpClient { get; set; } = default!;
+    public static PluginHttpClientFactory HttpClientFactory { get; set; } = default!;
     
     public static Task<List<MojangVersion>> GetVersion(
         string projectName,
@@ -39,8 +40,8 @@ private static async Task<List<MojangVersion>> GetVersionVanilla(
         CancellationToken cancellationToken)
     {
         var project = MojangProjectFactory.Projects.Single(p => p.Name.Equals(projectName));
-
-        var manifest = await HttpClient.GetFromJsonAsync<Manifest>(MojangVanillaRequestUri, cancellationToken) ??
+        var client = HttpClientFactory.GetClient();
+        var manifest = await client.GetFromJsonAsync<Manifest>(MojangVanillaRequestUri, cancellationToken) ??
             throw new InvalidOperationException("Could not acquire version details.");
         
         var versions = (from version in manifest.Versions
@@ -74,7 +75,8 @@ private static async Task<List<MojangVersion>> GetVersionBedrock(
         request.Headers.AcceptLanguage.ParseAdd("en-US, en");
         request.Headers.CacheControl = new CacheControlHeaderValue { NoCache = true };
 
-        var response = await HttpClient.SendAsync(request, cancellationToken);
+        var client = HttpClientFactory.GetClient();        
+        var response = await client.SendAsync(request, cancellationToken);
 
         if (!response.IsSuccessStatusCode)
             throw new InvalidOperationException("Could not acquire version details.");
@@ -120,7 +122,8 @@ private static async Task<IMinecraftDownload> GetDownloadVanilla(
         MojangVersion version,
         CancellationToken cancellationToken)
     {
-        var detail = await HttpClient.GetFromJsonAsync<Detail>(version.DetailUrl, cancellationToken) ??
+        var client = HttpClientFactory.GetClient();
+        var detail = await client.GetFromJsonAsync<Detail>(version.DetailUrl, cancellationToken) ??
             throw new InvalidOperationException("Could not acquire download details.");
         
         if (detail.Downloads.Server == null)
@@ -153,8 +156,9 @@ private static async Task<IMinecraftDownload> GetDownloadBedrock(
         
         if (options.LoadFilesize)
         {
+            var client = HttpClientFactory.GetClient();
             using var requestMessage = new HttpRequestMessage(HttpMethod.Get, version.DetailUrl);
-            using var httpResponse = await HttpClient.SendAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
+            using var httpResponse = await client.SendAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
 
             if (httpResponse.IsSuccessStatusCode)
                 contentLength = httpResponse.Content.Headers.ContentLength ?? 0;
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Paper/PaperProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Paper/PaperProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System.ComponentModel.Composition;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Projects;
 using MinecraftJars.Core.Providers;
 using MinecraftJars.Core.Versions;
@@ -9,12 +10,14 @@ namespace MinecraftJars.Plugin.Paper;
 public class PaperProvider : IMinecraftProvider
 {
     [ImportingConstructor]
-    public PaperProvider(ProviderOptions? options)
+    public PaperProvider(
+        PluginHttpClientFactory httpClientFactory, 
+        ProviderOptions? options)
     {
+        PaperVersionFactory.HttpClientFactory = httpClientFactory;
         ProviderOptions = options ?? new ProviderOptions();
-        PaperVersionFactory.HttpClient = ProviderOptions.GetHttpClient();
     }
-    
+
     public ProviderOptions ProviderOptions { get; }
     public string Name => "Paper";
     public byte[] Logo => Properties.Resources.Paper;
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Paper/PaperVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Paper/PaperVersionFactory.cs
@@ -1,4 +1,5 @@
 ﻿using System.Net.Http.Json;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Downloads;
 using MinecraftJars.Core.Versions;
 using MinecraftJars.Plugin.Paper.Model;
@@ -12,7 +13,7 @@ internal static class PaperVersionFactory
     private const string PaperBuildRequestUri = "https://api.papermc.io/v2/projects/{0}/versions/{1}/builds";
     private const string PaperDownloadRequestUri = "https://api.papermc.io/v2/projects/{0}/versions/{1}/builds/{2}/downloads/{3}";
 
-    public static HttpClient HttpClient { get; set; } = default!;
+    public static PluginHttpClientFactory HttpClientFactory { get; set; } = default!;
     
     public static async Task<List<PaperVersion>> GetVersion(
         string projectName,
@@ -21,7 +22,8 @@ public static async Task<List<PaperVersion>> GetVersion(
     {
         var project = PaperProjectFactory.Projects.Single(p => p.Name.Equals(projectName));
 
-        var projectApi = await HttpClient
+        var client = HttpClientFactory.GetClient();        
+        var projectApi = await client
             .GetFromJsonAsync<Project>(string.Format(PaperProjectRequestUri, project.Name.ToLower()), cancellationToken) ??
             throw new InvalidOperationException("Could not acquire version details.");                         
         
@@ -49,8 +51,9 @@ public static async Task<IMinecraftDownload> GetDownload(
         PaperVersion version,
         CancellationToken cancellationToken)
     {
+        var client = HttpClientFactory.GetClient();
         var requestUri = string.Format(PaperBuildRequestUri, version.Project.Name.ToLower(), version.Version);
-        var detail = await HttpClient.GetFromJsonAsync<BuildVersions>(requestUri, cancellationToken) ??
+        var detail = await client.GetFromJsonAsync<BuildVersions>(requestUri, cancellationToken) ??
             throw new InvalidOperationException("Could not acquire download details.");
         
         var build = detail.Builds.Last();
@@ -62,7 +65,7 @@ public static async Task<IMinecraftDownload> GetDownload(
         if (options.LoadFilesize)
         {
             using var requestMessage = new HttpRequestMessage(HttpMethod.Get, downloadUri);
-            using var httpResponse = await HttpClient
+            using var httpResponse = await client
                 .SendAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
 
             if (httpResponse.IsSuccessStatusCode)
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Pocketmine/PocketmineProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Pocketmine/PocketmineProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System.ComponentModel.Composition;
+using MinecraftJars.Core;
 using MinecraftJars.Core.Projects;
 using MinecraftJars.Core.Providers;
 using MinecraftJars.Core.Versions;
@@ -9,14 +10,15 @@ namespace MinecraftJars.Plugin.Pocketmine;
 public class PocketmineProvider : IMinecraftProvider
 {
     [ImportingConstructor]
-    public PocketmineProvider(ProviderOptions? options)
+    public PocketmineProvider(
+        PluginHttpClientFactory httpClientFactory, 
+        ProviderOptions? options)
     {
+        PocketmineVersionFactory.HttpClientFactory = httpClientFactory;
         ProviderOptions = options ?? new ProviderOptions();
-        PocketmineVersionFactory.HttpClient = ProviderOptions.GetHttpClient();
     }
     
     public ProviderOptions ProviderOptions { get; }
-    
     public string Name => "Pocketmine";
     public byte[] Logo => Properties.Resources.Pocketmine;
     public IEnumerable<IMinecraftProject> Projects => PocketmineProjectFactory.Projects;
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Pocketmine/PocketmineVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Pocketmine/PocketmineVersionFactory.cs
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Purpur/PurpurProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Purpur/PurpurProvider.cs
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Purpur/PurpurVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Purpur/PurpurVersionFactory.cs
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Spigot/SpigotProvider.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Spigot/SpigotProvider.cs
diff --git a/MinecraftJars.Plugin/MinecraftJars.Plugin.Spigot/SpigotVersionFactory.cs b/MinecraftJars.Plugin/MinecraftJars.Plugin.Spigot/SpigotVersionFactory.cs
diff --git a/MinecraftJars/MinecraftJarManager.cs b/MinecraftJars/MinecraftJarManager.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.ComponentModel.Composition;`
	`2`	`+using MinecraftJars.Core;`
`2`	`3`	`using MinecraftJars.Core.Projects;`
`3`	`4`	`using MinecraftJars.Core.Providers;`
`4`	`5`	`using MinecraftJars.Core.Versions;`
`@@ -9,10 +10,12 @@ namespace MinecraftJars.Plugin.Mojang;`
`9`	`10`	`public class MojangProvider : IMinecraftProvider`
`10`	`11`	`{`
`11`	`12`	`[ImportingConstructor]`
`12`		`- public MojangProvider(ProviderOptions? options)`
	`13`	`+ public MojangProvider(`
	`14`	`+ PluginHttpClientFactory httpClientFactory,`
	`15`	`+ ProviderOptions? options)`
`13`	`16`	`{`
	`17`	`+ MojangVersionFactory.HttpClientFactory = httpClientFactory;`
`14`	`18`	`ProviderOptions = options ?? new ProviderOptions();`
`15`		`- MojangVersionFactory.HttpClient = ProviderOptions.GetHttpClient();`
`16`	`19`	`}`
`17`	`20`
`18`	`21`	`public ProviderOptions ProviderOptions { get; }`