Changing the lifetime of the IRecaptchaService to scoped.

griesoft · Aug 14, 2022 · c00fdb7 · c00fdb7
1 parent 40dc647
commit c00fdb7
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 13 deletions.
diff --git a/docs/Griesoft.AspNetCore.ReCaptcha.xml b/docs/Griesoft.AspNetCore.ReCaptcha.xml
diff --git a/src/ReCaptcha/Configuration/RecaptchaServiceConstants.cs b/src/ReCaptcha/Configuration/RecaptchaServiceConstants.cs
@@ -24,5 +24,10 @@ public class RecaptchaServiceConstants
         /// The section name in the appsettings.json from which the settings are read.
         /// </summary>
         public const string SettingsSectionKey = "RecaptchaSettings";
+
+        /// <summary>
+        /// The named HttpClient name that we use in the IRecpatchaService.
+        /// </summary>
+        public const string RecaptchaServiceHttpClientName = "ReCaptchaValidationClient";
     }
 }
diff --git a/src/ReCaptcha/Extensions/RecaptchaServiceExtensions.cs b/src/ReCaptcha/Extensions/RecaptchaServiceExtensions.cs
@@ -26,11 +26,13 @@ public static IServiceCollection AddRecaptchaService(this IServiceCollection ser
 
             services.Configure(options ??= opt => { });
 
-            services.AddHttpClient<IRecaptchaService, RecaptchaService>(client =>
+            services.AddHttpClient(RecaptchaServiceConstants.RecaptchaServiceHttpClientName, client =>
             {
                 client.BaseAddress = new Uri(RecaptchaServiceConstants.GoogleRecaptchaEndpoint);
             });
 
+            services.AddScoped<IRecaptchaService, RecaptchaService>();
+
             services.AddTransient<IValidateRecaptchaFilter, ValidateRecaptchaFilter>();
 
             return services;

diff --git a/src/ReCaptcha/Services/RecaptchaService.cs b/src/ReCaptcha/Services/RecaptchaService.cs
@@ -17,14 +17,14 @@ namespace Griesoft.AspNetCore.ReCaptcha.Services
     internal class RecaptchaService : IRecaptchaService
     {
         private readonly RecaptchaSettings _settings;
-        private readonly HttpClient _httpClient;
+        private readonly IHttpClientFactory _httpClientFactory;
         private readonly ILogger<RecaptchaService> _logger;
 
         public RecaptchaService(IOptionsMonitor<RecaptchaSettings> settings,
-            HttpClient httpClient, ILogger<RecaptchaService> logger)
+            IHttpClientFactory httpClientFactory, ILogger<RecaptchaService> logger)
         {
             _settings = settings.CurrentValue;
-            _httpClient = httpClient;
+            _httpClientFactory = httpClientFactory;
             _logger = logger;
         }
 
@@ -38,7 +38,8 @@ public async Task<ValidationResponse> ValidateRecaptchaResponse(string token, st
 
             try
             {
-                var response = await _httpClient.PostAsync($"?secret={_settings.SecretKey}&response={token}{(remoteIp != null ? $"&remoteip={remoteIp}" : "")}", null!)
+                var httpClient = _httpClientFactory.CreateClient(RecaptchaServiceConstants.RecaptchaServiceHttpClientName);
+                var response = await httpClient.PostAsync($"?secret={_settings.SecretKey}&response={token}{(remoteIp != null ? $"&remoteip={remoteIp}" : "")}", null!)
                     .ConfigureAwait(true);
 
                 response.EnsureSuccessStatusCode();

diff --git a/tests/ReCaptcha.Tests/Extensions/RecaptchaServiceExtensionsTests.cs b/tests/ReCaptcha.Tests/Extensions/RecaptchaServiceExtensionsTests.cs
@@ -17,8 +17,8 @@ public void AddRecaptchaService_ShouldAddAllRequired_WithDefaultOptions()
             services.AddRecaptchaService();
 
             // Assert
-            Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Griesoft.AspNetCore.ReCaptcha.Services.IRecaptchaService"));
-            Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Griesoft.AspNetCore.ReCaptcha.Filters.IValidateRecaptchaFilter"));
+            Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Griesoft.AspNetCore.ReCaptcha.Services.IRecaptchaService" && service.Lifetime == ServiceLifetime.Scoped));
+            Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Griesoft.AspNetCore.ReCaptcha.Filters.IValidateRecaptchaFilter" && service.Lifetime == ServiceLifetime.Transient));
             Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Microsoft.Extensions.Options.IConfigureOptions`1[[Griesoft.AspNetCore.ReCaptcha.Configuration.RecaptchaOptions, Griesoft.AspNetCore.ReCaptcha, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"));
             Assert.IsTrue(services.Any(service => service.ServiceType.FullName == "Microsoft.Extensions.Options.IConfigureOptions`1[[Griesoft.AspNetCore.ReCaptcha.Configuration.RecaptchaSettings, Griesoft.AspNetCore.ReCaptcha, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"));
         }

diff --git a/tests/ReCaptcha.Tests/Services/RecaptchaServiceTests.cs b/tests/ReCaptcha.Tests/Services/RecaptchaServiceTests.cs
@@ -26,6 +26,7 @@ public class RecaptchaServiceTests
         private Mock<IOptionsMonitor<RecaptchaSettings>> _settingsMock;
         private Mock<HttpMessageHandler> _httpMessageHandlerMock;
         private HttpClient _httpClient;
+        private Mock<IHttpClientFactory> _httpClientFactory;
 
         [SetUp]
         public void Initialize()
@@ -59,6 +60,11 @@ public void Initialize()
             {
                 BaseAddress = new Uri("http://test.com/"),
             };
+
+            _httpClientFactory = new Mock<IHttpClientFactory>();
+            _httpClientFactory.Setup(instance => instance.CreateClient(It.Is<string>(val => val == RecaptchaServiceConstants.RecaptchaServiceHttpClientName)))
+                .Returns(_httpClient)
+                .Verifiable();
         }
 
         [Test]
@@ -68,7 +74,7 @@ public void Construction_IsSuccessful()
 
 
             // Act
-            var instance = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            var instance = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Assert
             Assert.NotNull(instance);
@@ -79,7 +85,7 @@ public void Construction_IsSuccessful()
         public void ValidateRecaptchaResponse_ShouldThrow_ArgumentNullException()
         {
             // Arrange
-            var service = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            var service = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Act
 
@@ -110,13 +116,19 @@ public async Task ValidateRecaptchaResponse_ShouldReturn_HttpRequestError()
                 BaseAddress = new Uri("http://test.com/"),
             };
 
-            var service = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            _httpClientFactory = new Mock<IHttpClientFactory>();
+            _httpClientFactory.Setup(instance => instance.CreateClient(It.Is<string>(val => val == RecaptchaServiceConstants.RecaptchaServiceHttpClientName)))
+                .Returns(_httpClient)
+                .Verifiable();
+
+            var service = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Act
             var response = await service.ValidateRecaptchaResponse(Token);
 
             // Assert
             _httpMessageHandlerMock.Verify();
+            _httpClientFactory.Verify();
             Assert.GreaterOrEqual(response.Errors.Count(), 1);
             Assert.AreEqual(ValidationError.HttpRequestFailed, response.Errors.First());
         }
@@ -140,21 +152,27 @@ public void ValidateRecaptchaResponse_ShouldThrowAnyOtherThan_HttpRequestExcepti
                 BaseAddress = new Uri("http://test.com/"),
             };
 
-            var service = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            _httpClientFactory = new Mock<IHttpClientFactory>();
+            _httpClientFactory.Setup(instance => instance.CreateClient(It.Is<string>(val => val == RecaptchaServiceConstants.RecaptchaServiceHttpClientName)))
+                .Returns(_httpClient)
+                .Verifiable();
+
+            var service = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Act
 
 
             // Assert
             Assert.ThrowsAsync<Exception>(() => service.ValidateRecaptchaResponse(Token));
             _httpMessageHandlerMock.Verify();
+            _httpClientFactory.Verify();
         }
 
         [Test]
         public async Task ValidateRecaptchaResponse_ShouldReturn_DeserializedResponse()
         {
             // Arrange
-            var service = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            var service = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Act
             var response = await service.ValidateRecaptchaResponse(Token);
@@ -169,13 +187,14 @@ public async Task ValidateRecaptchaResponse_ShouldReturn_DeserializedResponse()
         public async Task ValidateRecaptchaResponse_Should_DeserializedResponse_AndSet_ValidationResponseProperty()
         {
             // Arrange
-            var service = new RecaptchaService(_settingsMock.Object, _httpClient, _logger);
+            var service = new RecaptchaService(_settingsMock.Object, _httpClientFactory.Object, _logger);
 
             // Act
             var response = await service.ValidateRecaptchaResponse(Token);
 
             // Assert
             _httpMessageHandlerMock.Verify();
+            _httpClientFactory.Verify();
             Assert.IsTrue(response.Success);
             Assert.AreEqual(0, response.Errors.Count());
             Assert.NotNull(service.ValidationResponse);