Enables HTTP compression via IHttpClientFactory (#1030)

* Setup IHttpClientFactory with compression enabled * IHttpClientFactory setup for remaining platforms
NuKeeperDotNet · Aug 31, 2020 · 09bed2f · 09bed2f
1 parent 0926036
commit 09bed2f
Show file tree

Hide file tree

Showing 22 changed files with 135 additions and 67 deletions.
diff --git a/NuKeeper.Abstractions/NuKeeper.Abstractions.csproj b/NuKeeper.Abstractions/NuKeeper.Abstractions.csproj
@@ -10,6 +10,7 @@
 
   <ItemGroup>
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="3.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Http" Version="3.1.7" />
     <PackageReference Include="NuGet.Protocol" Version="5.7.0" />
   </ItemGroup>
 

diff --git a/NuKeeper.AzureDevOps/AzureDevOpsRestClient.cs b/NuKeeper.AzureDevOps/AzureDevOpsRestClient.cs
@@ -19,10 +19,13 @@ public class AzureDevOpsRestClient
         private readonly HttpClient _client;
         private readonly INuKeeperLogger _logger;
 
-        public AzureDevOpsRestClient(HttpClient client, INuKeeperLogger logger, string personalAccessToken)
+        public AzureDevOpsRestClient(IHttpClientFactory clientFactory, INuKeeperLogger logger,
+            string personalAccessToken, Uri apiBaseAddress)
         {
-            _client = client ?? throw new ArgumentNullException(nameof(client));
             _logger = logger;
+
+            _client = clientFactory.CreateClient();
+            _client.BaseAddress = apiBaseAddress;
             _client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
             _client.DefaultRequestHeaders.Authorization =
                 new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes($"{string.Empty}:{personalAccessToken}")));

diff --git a/NuKeeper.AzureDevOps/AzureDevopsPlatform.cs b/NuKeeper.AzureDevOps/AzureDevopsPlatform.cs
@@ -13,11 +13,13 @@ namespace NuKeeper.AzureDevOps
     public class AzureDevOpsPlatform : ICollaborationPlatform
     {
         private readonly INuKeeperLogger _logger;
+        private readonly IHttpClientFactory _clientFactory;
         private AzureDevOpsRestClient _client;
 
-        public AzureDevOpsPlatform(INuKeeperLogger logger)
+        public AzureDevOpsPlatform(INuKeeperLogger logger, IHttpClientFactory clientFactory)
         {
             _logger = logger;
+            _clientFactory = clientFactory;
         }
 
         public void Initialise(AuthSettings settings)
@@ -27,11 +29,7 @@ public void Initialise(AuthSettings settings)
                 throw new ArgumentNullException(nameof(settings));
             }
 
-            var httpClient = new HttpClient
-            {
-                BaseAddress = settings.ApiBase
-            };
-            _client = new AzureDevOpsRestClient(httpClient, _logger, settings.Token);
+            _client = new AzureDevOpsRestClient(_clientFactory, _logger, settings.Token, settings.ApiBase);
         }
 
         public Task<User> GetCurrentUser()

diff --git a/NuKeeper.BitBucket/BitbucketPlatform.cs b/NuKeeper.BitBucket/BitbucketPlatform.cs
@@ -16,22 +16,20 @@ namespace NuKeeper.BitBucket
     public class BitbucketPlatform : ICollaborationPlatform
     {
         private readonly INuKeeperLogger _logger;
+        private readonly IHttpClientFactory _clientFactory;
         private BitbucketRestClient _client;
         private AuthSettings _settings;
 
-        public BitbucketPlatform(INuKeeperLogger logger)
+        public BitbucketPlatform(INuKeeperLogger logger, IHttpClientFactory clientFactory)
         {
             _logger = logger;
+            _clientFactory = clientFactory;
         }
 
         public void Initialise(AuthSettings settings)
         {
             _settings = settings ?? throw new ArgumentNullException(nameof(settings));
-            var httpClient = new HttpClient
-            {
-                BaseAddress = settings.ApiBase
-            };
-            _client = new BitbucketRestClient(httpClient, _logger, settings.Username, settings.Token);
+            _client = new BitbucketRestClient(_clientFactory, _logger, settings.Username, settings.Token, settings.ApiBase);
         }
 
         public Task<User> GetCurrentUser()

diff --git a/NuKeeper.BitBucket/BitbucketRestClient.cs b/NuKeeper.BitBucket/BitbucketRestClient.cs
@@ -21,11 +21,13 @@ public class BitbucketRestClient
         private readonly HttpClient _client;
         private readonly INuKeeperLogger _logger;
 
-        public BitbucketRestClient(HttpClient client, INuKeeperLogger logger, string username, string appPassword)
+        public BitbucketRestClient(IHttpClientFactory clientFactory, INuKeeperLogger logger, string username,
+            string appPassword, Uri apiBaseAddress)
         {
-            _client = client ?? throw new ArgumentNullException(nameof(client));
             _logger = logger;
 
+            _client = clientFactory.CreateClient();
+            _client.BaseAddress = apiBaseAddress;
             var byteArray = Encoding.ASCII.GetBytes($"{username}:{appPassword}");
             _client.DefaultRequestHeaders.Authorization =
                 new AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));

diff --git a/NuKeeper.Gitea.Tests/GiteaSettingsReaderTests.cs b/NuKeeper.Gitea.Tests/GiteaSettingsReaderTests.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Net.Http;
 using System.Threading.Tasks;
 using NSubstitute;
 using NuKeeper.Abstractions.CollaborationPlatform;
@@ -20,7 +21,9 @@ public void Setup()
         {
             _environmentVariablesProvider = Substitute.For<IEnvironmentVariablesProvider>();
             _gitDiscovery = Substitute.For<IGitDiscoveryDriver>();
-            _giteaSettingsReader = new GiteaSettingsReader(_gitDiscovery, _environmentVariablesProvider);
+            var httpClientFactory = Substitute.For<IHttpClientFactory>();
+            httpClientFactory.CreateClient().Returns(new HttpClient());
+            _giteaSettingsReader = new GiteaSettingsReader(_gitDiscovery, _environmentVariablesProvider, httpClientFactory);
         }
 
         [Test]

diff --git a/NuKeeper.Gitea/GiteaPlatform.cs b/NuKeeper.Gitea/GiteaPlatform.cs
@@ -14,11 +14,13 @@ namespace NuKeeper.Gitea
     public class GiteaPlatform : ICollaborationPlatform
     {
         private readonly INuKeeperLogger _logger;
+        private readonly IHttpClientFactory _clientFactory;
         private GiteaRestClient _client;
 
-        public GiteaPlatform(INuKeeperLogger logger)
+        public GiteaPlatform(INuKeeperLogger logger, IHttpClientFactory clientFactory)
         {
             _logger = logger;
+            _clientFactory = clientFactory;
         }
 
         public void Initialise(AuthSettings settings)
@@ -28,12 +30,7 @@ public void Initialise(AuthSettings settings)
                 throw new ArgumentNullException(nameof(settings));
             }
 
-            var httpClient = new HttpClient
-            {
-                BaseAddress = settings.ApiBase
-            };
-
-            _client = new GiteaRestClient(httpClient, settings.Token, _logger);
+            _client = new GiteaRestClient(_clientFactory, settings.Token, _logger, settings.ApiBase);
         }
 
         public async Task<User> GetCurrentUser()

diff --git a/NuKeeper.Gitea/GiteaRestClient.cs b/NuKeeper.Gitea/GiteaRestClient.cs
@@ -20,11 +20,13 @@ public class GiteaRestClient
         private readonly HttpClient _client;
         private readonly INuKeeperLogger _logger;
 
-        public GiteaRestClient(HttpClient client, string token, INuKeeperLogger logger)
+        public GiteaRestClient(IHttpClientFactory clientFactory, string token, INuKeeperLogger logger,
+            Uri apiBaseAddress)
         {
-            _client = client ?? throw new ArgumentNullException(nameof(client));
             _logger = logger;
 
+            _client = clientFactory.CreateClient();
+            _client.BaseAddress = apiBaseAddress;
             _client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
             _client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("token", token);
         }

diff --git a/NuKeeper.Gitea/GiteaSettingsReader.cs b/NuKeeper.Gitea/GiteaSettingsReader.cs
@@ -17,10 +17,13 @@ public class GiteaSettingsReader : ISettingsReader
         private const string UrlPattern = "https://yourgiteaserver/{owner}/{repo}.git";
         private const string ApiBaseAdress = "api/v1/";
         private readonly IGitDiscoveryDriver _gitDriver;
+        private readonly IHttpClientFactory _clientFactory;
 
-        public GiteaSettingsReader(IGitDiscoveryDriver gitDiscoveryDriver, IEnvironmentVariablesProvider environmentVariablesProvider)
+        public GiteaSettingsReader(IGitDiscoveryDriver gitDiscoveryDriver, IEnvironmentVariablesProvider environmentVariablesProvider,
+            IHttpClientFactory clientFactory)
         {
             _environmentVariablesProvider = environmentVariablesProvider;
+            _clientFactory = clientFactory;
             _gitDriver = gitDiscoveryDriver;
         }
 
@@ -34,11 +37,8 @@ public async Task<bool> CanRead(Uri repositoryUri)
             try
             {
                 // There is no real identifier for gitea repos so try to get the gitea swagger json
-                var client = new HttpClient()
-                {
-                    BaseAddress = GetBaseAddress(repositoryUri)
-                };
-
+                var client = _clientFactory.CreateClient();
+                client.BaseAddress = GetBaseAddress(repositoryUri);
                 client.DefaultRequestHeaders.Accept.Add(
                     new MediaTypeWithQualityHeaderValue("application/json"));
 

diff --git a/NuKeeper.Gitlab/GitlabPlatform.cs b/NuKeeper.Gitlab/GitlabPlatform.cs
@@ -16,11 +16,13 @@ namespace NuKeeper.Gitlab
     public class GitlabPlatform : ICollaborationPlatform
     {
         private readonly INuKeeperLogger _logger;
+        private readonly IHttpClientFactory _clientFactory;
         private GitlabRestClient _client;
 
-        public GitlabPlatform(INuKeeperLogger logger)
+        public GitlabPlatform(INuKeeperLogger logger, IHttpClientFactory clientFactory)
         {
             _logger = logger;
+            _clientFactory = clientFactory;
         }
 
         public void Initialise(AuthSettings settings)
@@ -30,11 +32,7 @@ public void Initialise(AuthSettings settings)
                 throw new ArgumentNullException(nameof(settings));
             }
 
-            var httpClient = new HttpClient
-            {
-                BaseAddress = settings.ApiBase
-            };
-            _client = new GitlabRestClient(httpClient, settings.Token, _logger);
+            _client = new GitlabRestClient(_clientFactory, settings.Token, _logger, settings.ApiBase);
         }
 
         public async Task<User> GetCurrentUser()

diff --git a/NuKeeper.Gitlab/GitlabRestClient.cs b/NuKeeper.Gitlab/GitlabRestClient.cs
@@ -18,11 +18,12 @@ public class GitlabRestClient
         private readonly HttpClient _client;
         private readonly INuKeeperLogger _logger;
 
-        public GitlabRestClient(HttpClient client, string token, INuKeeperLogger logger)
+        public GitlabRestClient(IHttpClientFactory clientFactory, string token, INuKeeperLogger logger, Uri apiBaseAddress)
         {
-            _client = client ?? throw new ArgumentNullException(nameof(client));
             _logger = logger;
 
+            _client = clientFactory.CreateClient();
+            _client.BaseAddress = apiBaseAddress;
             _client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
             _client.DefaultRequestHeaders.Add("Private-Token", token);
         }

diff --git a/NuKeeper.Tests/Commands/GlobalCommandTests.cs b/NuKeeper.Tests/Commands/GlobalCommandTests.cs
@@ -10,6 +10,7 @@
 using NUnit.Framework;
 using System;
 using System.Collections.Generic;
+using System.Net.Http;
 using System.Threading.Tasks;
 using NuKeeper.Abstractions.Git;
 using NuKeeper.AzureDevOps;
@@ -23,9 +24,13 @@ private static CollaborationFactory GetCollaborationFactory(Func<IGitDiscoveryDr
         {
             var environmentVariablesProvider = Substitute.For<IEnvironmentVariablesProvider>();
 
+            var httpClientFactory = Substitute.For<IHttpClientFactory>();
+            httpClientFactory.CreateClient().Returns(new HttpClient());
+
             return new CollaborationFactory(
                 new ISettingsReader[] { createSettingsReader(new MockedGitDiscoveryDriver(), environmentVariablesProvider) },
-                Substitute.For<INuKeeperLogger>()
+                Substitute.For<INuKeeperLogger>(),
+                httpClientFactory
             );
         }
 

diff --git a/NuKeeper.Tests/Commands/OrganisationCommandTests.cs b/NuKeeper.Tests/Commands/OrganisationCommandTests.cs
@@ -10,6 +10,7 @@
 using NUnit.Framework;
 using System;
 using System.Collections.Generic;
+using System.Net.Http;
 using System.Threading.Tasks;
 using NuKeeper.Abstractions.Git;
 using NuKeeper.AzureDevOps;
@@ -23,9 +24,13 @@ private static CollaborationFactory GetCollaborationFactory(Func<IGitDiscoveryDr
         {
             var environmentVariablesProvider = Substitute.For<IEnvironmentVariablesProvider>();
 
+            var httpClientFactory = Substitute.For<IHttpClientFactory>();
+            httpClientFactory.CreateClient().Returns(new HttpClient());
+
             return new CollaborationFactory(
                 new ISettingsReader[] { createSettingsReader(new MockedGitDiscoveryDriver(), environmentVariablesProvider) },
-                Substitute.For<INuKeeperLogger>()
+                Substitute.For<INuKeeperLogger>(),
+                httpClientFactory
             );
         }
 

diff --git a/NuKeeper.Tests/Commands/RepositoryCommandTests.cs b/NuKeeper.Tests/Commands/RepositoryCommandTests.cs
@@ -548,7 +548,8 @@ public async Task WillReadMaxPackageUpdatesFromFile()
         {
             return new CollaborationFactory(
                 settingReaders ?? new ISettingsReader[] { new GitHubSettingsReader(new MockedGitDiscoveryDriver(), environmentVariablesProvider) },
-                Substitute.For<INuKeeperLogger>()
+                Substitute.For<INuKeeperLogger>(),
+                null
             );
         }
     }

diff --git a/NuKeeper.Tests/Engine/CollaborationFactoryTests.cs b/NuKeeper.Tests/Engine/CollaborationFactoryTests.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Net.Http;
 using System.Threading.Tasks;
 using NSubstitute;
 using NuKeeper.Abstractions.CollaborationPlatform;
@@ -31,7 +32,10 @@ private static CollaborationFactory GetCollaborationFactory()
 
             var readers = new List<ISettingsReader> { settingReader1, settingReader2 };
             var logger = Substitute.For<INuKeeperLogger>();
-            return new CollaborationFactory(readers, logger);
+            var httpClientFactory = Substitute.For<IHttpClientFactory>();
+            httpClientFactory.CreateClient().Returns(new HttpClient());
+
+            return new CollaborationFactory(readers, logger, httpClientFactory);
         }
 
         [Test]

diff --git a/NuKeeper/Collaboration/CollaborationFactory.cs b/NuKeeper/Collaboration/CollaborationFactory.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Net.Http;
 using System.Threading.Tasks;
 using NuKeeper.Abstractions;
 using NuKeeper.Abstractions.CollaborationPlatform;
@@ -21,6 +22,7 @@ public class CollaborationFactory : ICollaborationFactory
     {
         private readonly IEnumerable<ISettingsReader> _settingReaders;
         private readonly INuKeeperLogger _nuKeeperLogger;
+        private readonly IHttpClientFactory _httpClientFactory;
         private Platform? _platform;
 
         public IForkFinder ForkFinder { get; private set; }
@@ -34,10 +36,11 @@ public class CollaborationFactory : ICollaborationFactory
         public CollaborationPlatformSettings Settings { get; }
 
         public CollaborationFactory(IEnumerable<ISettingsReader> settingReaders,
-            INuKeeperLogger nuKeeperLogger)
+            INuKeeperLogger nuKeeperLogger, IHttpClientFactory httpClientFactory)
         {
             _settingReaders = settingReaders;
             _nuKeeperLogger = nuKeeperLogger;
+            _httpClientFactory = httpClientFactory;
             Settings = new CollaborationPlatformSettings();
         }
 
@@ -133,7 +136,7 @@ private void CreateForPlatform()
             switch (_platform.Value)
             {
                 case Platform.AzureDevOps:
-                    CollaborationPlatform = new AzureDevOpsPlatform(_nuKeeperLogger);
+                    CollaborationPlatform = new AzureDevOpsPlatform(_nuKeeperLogger, _httpClientFactory);
                     RepositoryDiscovery = new AzureDevOpsRepositoryDiscovery(_nuKeeperLogger, CollaborationPlatform, Settings.Token);
                     ForkFinder = new AzureDevOpsForkFinder(CollaborationPlatform, _nuKeeperLogger, forkMode);
 
@@ -150,28 +153,28 @@ private void CreateForPlatform()
                     break;
 
                 case Platform.Bitbucket:
-                    CollaborationPlatform = new BitbucketPlatform(_nuKeeperLogger);
+                    CollaborationPlatform = new BitbucketPlatform(_nuKeeperLogger, _httpClientFactory);
                     RepositoryDiscovery = new BitbucketRepositoryDiscovery(_nuKeeperLogger);
                     ForkFinder = new BitbucketForkFinder(CollaborationPlatform, _nuKeeperLogger, forkMode);
                     CommitWorder = new BitbucketCommitWorder();
                     break;
 
                 case Platform.BitbucketLocal:
-                    CollaborationPlatform = new BitBucketLocalPlatform(_nuKeeperLogger);
+                    CollaborationPlatform = new BitBucketLocalPlatform(_nuKeeperLogger, _httpClientFactory);
                     RepositoryDiscovery = new BitbucketLocalRepositoryDiscovery(_nuKeeperLogger, CollaborationPlatform, Settings);
                     ForkFinder = new BitbucketForkFinder(CollaborationPlatform, _nuKeeperLogger, forkMode);
                     CommitWorder = new DefaultCommitWorder();
                     break;
 
                 case Platform.GitLab:
-                    CollaborationPlatform = new GitlabPlatform(_nuKeeperLogger);
+                    CollaborationPlatform = new GitlabPlatform(_nuKeeperLogger, _httpClientFactory);
                     RepositoryDiscovery = new GitlabRepositoryDiscovery(_nuKeeperLogger, CollaborationPlatform);
                     ForkFinder = new GitlabForkFinder(CollaborationPlatform, _nuKeeperLogger, forkMode);
                     CommitWorder = new DefaultCommitWorder();
                     break;
 
                 case Platform.Gitea:
-                    CollaborationPlatform = new GiteaPlatform(_nuKeeperLogger);
+                    CollaborationPlatform = new GiteaPlatform(_nuKeeperLogger, _httpClientFactory);
                     RepositoryDiscovery = new GiteaRepositoryDiscovery(_nuKeeperLogger, CollaborationPlatform);
                     ForkFinder = new GiteaForkFinder(CollaborationPlatform, _nuKeeperLogger, forkMode);
                     CommitWorder = new DefaultCommitWorder();