cancellationToken

Author: BenjaminMichaelis

EssentialCSharp.Web.Tests/Integration/CaptchaTests.cs

@@ -19,10 +19,7 @@ public async Task CaptchaService_Verify_Success(CancellationToken cancellationTo
         string hCaptchaSecret = "0x0000000000000000000000000000000000000000";
         string hCaptchaToken = "10000000-aaaa-bbbb-cccc-000000000001";
         string hCaptchaSiteKey = "10000000-ffff-ffff-ffff-000000000001";
-        // Note: cancellationToken is not passed to VerifyAsync because ICaptchaService.VerifyAsync
-        // does not currently accept a CancellationToken. If the timeout fires, the underlying
-        // HTTP request will continue running in the background.
-        HCaptchaResult? response = await captchaService.VerifyAsync(hCaptchaSecret, hCaptchaToken, hCaptchaSiteKey);
+        HCaptchaResult? response = await captchaService.VerifyAsync(hCaptchaSecret, hCaptchaToken, hCaptchaSiteKey, cancellationToken);
 
         await Assert.That(response).IsNotNull();
         await Assert.That(response.Success).IsTrue();

EssentialCSharp.Web/Services/CaptchaService.cs

@@ -11,7 +11,7 @@ public class CaptchaService(IHttpClientFactory clientFactory, IOptions<CaptchaOp
 
     // Verify captcha. Optionally add overload to pass in remoteIp as in the docs
     // https://docs.hcaptcha.com/#verify-the-user-response-server-side
-    public async Task<HCaptchaResult?> VerifyAsync(string secret, string response, string sitekey)
+    public async Task<HCaptchaResult?> VerifyAsync(string secret, string response, string sitekey, CancellationToken cancellationToken = default)
     {
         // create post data
         List<KeyValuePair<string, string>> postData =
@@ -21,10 +21,10 @@ public class CaptchaService(IHttpClientFactory clientFactory, IOptions<CaptchaOp
             new KeyValuePair<string, string>("sitekey", sitekey)
         ];
 
-        return await PostVerification(postData);
+        return await PostVerification(postData, cancellationToken);
     }
 
-    public async Task<HCaptchaResult?> VerifyAsync(string? response)
+    public async Task<HCaptchaResult?> VerifyAsync(string? response, CancellationToken cancellationToken = default)
     {
         if (string.IsNullOrWhiteSpace(response))
         {
@@ -33,21 +33,21 @@ public class CaptchaService(IHttpClientFactory clientFactory, IOptions<CaptchaOp
         string secret = Options.SecretKey ?? throw new InvalidOperationException($"{CaptchaOptions.CaptchaSender} {nameof(Options.SecretKey)} is unexpectedly null");
         string sitekey = Options.SiteKey ?? throw new InvalidOperationException($"{CaptchaOptions.CaptchaSender} {nameof(Options.SiteKey)} is unexpectedly null");
 
-        return await VerifyAsync(secret, response, sitekey);
+        return await VerifyAsync(secret, response, sitekey, cancellationToken);
     }
 
-    public async Task<HCaptchaResult?> PostVerification(List<KeyValuePair<string, string>> postData)
+    public async Task<HCaptchaResult?> PostVerification(List<KeyValuePair<string, string>> postData, CancellationToken cancellationToken = default)
     {
         HttpClient client = ClientFactory.CreateClient("hCaptcha");
 
         // request api
         HttpResponseMessage res = await client.PostAsync(
             // base url is given in IHttpClientFactory service registration
             // hCaptcha wants URL-encoded POST
-            "/siteverify", new FormUrlEncodedContent(postData));
+            "/siteverify", new FormUrlEncodedContent(postData), cancellationToken);
 
         res.EnsureSuccessStatusCode();
         // convert JSON string into Class
-        return JsonSerializer.Deserialize<HCaptchaResult>(await res.Content.ReadAsStringAsync());
+        return JsonSerializer.Deserialize<HCaptchaResult>(await res.Content.ReadAsStringAsync(cancellationToken));
     }
 }

EssentialCSharp.Web/Services/ICaptchaService.cs

@@ -4,6 +4,6 @@ namespace EssentialCSharp.Web.Services;
 
 public interface ICaptchaService
 {
-    Task<HCaptchaResult?> VerifyAsync(string secret, string response, string sitekey);
-    Task<HCaptchaResult?> VerifyAsync(string? response);
+    Task<HCaptchaResult?> VerifyAsync(string secret, string response, string sitekey, CancellationToken cancellationToken = default);
+    Task<HCaptchaResult?> VerifyAsync(string? response, CancellationToken cancellationToken = default);
 }