Refactor to address review comments

Author: kailash-b

EXAMPLES.md

@@ -518,6 +518,8 @@ public async Task<IActionResult> InitiateLoginWithCiba(string returnUrl = "/")
     return RedirectToAction("Waiting");
 }
 
+// You could use the built-in polling mechanism or could implement your own polling mechanism by 
+// accessing the `GetTokenAsync` method using the AuthenticationApiClient as shown in the example before.
 [HttpGet]
 public async Task<IActionResult> CheckCibaStatus()
 {

src/Auth0.AspNetCore.Authentication/Auth0WebAppAuthenticationBuilder.cs

@@ -7,6 +7,7 @@
 using Auth0.AspNetCore.Authentication.BackchannelLogout;
 using Auth0.AspNetCore.Authentication.ClientInitiatedBackChannelAuthentication;
 using Auth0.AuthenticationApi;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Auth0.AspNetCore.Authentication
 {
@@ -81,7 +82,10 @@ public Auth0WebAppAuthenticationBuilder WithAuthenticationApiClient()
         /// <returns></returns>
         public Auth0WebAppAuthenticationBuilder WithClientInitiatedBackchannelAuthentication()
         {
-            _services.AddScoped<IAuth0CibaService, Auth0CibaService>();
+            _services.TryAddSingleton<IAuthenticationApiClient>(
+                _ => new AuthenticationApiClient(new Uri($"https://{_options.Domain}")));
+            _services.TryAddScoped<IAuth0CibaService, Auth0CibaService>();
+
             return this;
         }
 

src/Auth0.AspNetCore.Authentication/ClientInitiatedBackChannelAuthentication/Auth0CibaService.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Threading;
 using System.Threading.Tasks;
 
 using Microsoft.Extensions.Logging;
@@ -16,6 +17,12 @@ internal class Auth0CibaService : IAuth0CibaService
     private readonly Auth0WebAppOptions _options;
     private readonly ILogger<Auth0CibaService> _logger;
 
+    /// <summary>
+    /// Initiates an instance of Auth0CibaService which can be used to execute the CIBA workflow.
+    /// </summary>
+    /// <param name="authenticationApiClient">Instance of <see cref="Auth0.AuthenticationApi.IAuthenticationApiClient"/> </param>
+    /// <param name="optionsAccessor"><see cref="Auth0WebAppOptions"/></param>
+    /// <param name="logger"></param>
     public Auth0CibaService(
         IAuthenticationApiClient authenticationApiClient,
         IOptions<Auth0WebAppOptions> optionsAccessor,
@@ -26,7 +33,9 @@ public Auth0CibaService(
         _logger = logger;
     }
 
-    public async Task<CibaInitiationDetails> InitiateAuthenticationAsync(CibaInitiationRequest request)
+    /// <inheritdoc cref="Auth0.AspNetCore.Authentication.ClientInitiatedBackChannelAuthentication.IAuth0CibaService.InitiateAuthenticationAsync"/>
+    public async Task<CibaInitiationDetails> InitiateAuthenticationAsync(
+        CibaInitiationRequest request)
     {
         try
         {
@@ -63,7 +72,9 @@ public async Task<CibaInitiationDetails> InitiateAuthenticationAsync(CibaInitiat
         }
     }
 
-    public async Task<CibaCompletionDetails> PollForTokensAsync(CibaInitiationDetails initDetails)
+    /// <inheritdoc cref="Auth0.AspNetCore.Authentication.ClientInitiatedBackChannelAuthentication.IAuth0CibaService.PollForTokensAsync"/>
+    public async Task<CibaCompletionDetails> PollForTokensAsync(
+        CibaInitiationDetails initDetails, CancellationToken cancellationToken)
     {
         var request = new ClientInitiatedBackchannelAuthorizationTokenRequest()
         {
@@ -74,24 +85,27 @@ public async Task<CibaCompletionDetails> PollForTokensAsync(CibaInitiationDetail
             AuthRequestId = initDetails.AuthRequestId
         };
 
-        while (true)
+        var completionDetails = new CibaCompletionDetails()
+        {
+            IsSuccessful = false,
+            IsAuthenticationPending = true
+        };
+        
+        while (completionDetails is { IsAuthenticationPending: true, IsSuccessful: false })
         {
             _logger.LogDebug($"Polling CIBA token endpoint for auth_req_id: {initDetails.AuthRequestId} ");
             try
             {
-                var response = await _authenticationApiClient.GetTokenAsync(request);
-               
-                return new CibaCompletionDetails
-                {
-                    AccessToken = response.AccessToken,
-                    IdToken = response.IdToken,
-                    TokenType = response.TokenType,
-                    Scope = response.Scope,
-                    ExpiresIn = response.ExpiresIn,
-                    RefreshToken = response.RefreshToken,
-                    IsSuccessful = true,
-                    IsAuthenticationPending = false,
-                };
+                var response = await _authenticationApiClient.GetTokenAsync(request, cancellationToken);
+
+                completionDetails.AccessToken = response.AccessToken;
+                completionDetails.IdToken = response.IdToken;
+                completionDetails.TokenType = response.TokenType;
+                completionDetails.Scope = response.Scope;
+                completionDetails.ExpiresIn = response.ExpiresIn;
+                completionDetails.RefreshToken = response.RefreshToken;
+                completionDetails.IsSuccessful = true;
+                completionDetails.IsAuthenticationPending = false;
             }
             catch (ErrorApiException ex)
             {
@@ -102,18 +116,16 @@ public async Task<CibaCompletionDetails> PollForTokensAsync(CibaInitiationDetail
 
                 if (ex.ApiError.Error.Contains("authorization_pending", StringComparison.OrdinalIgnoreCase))
                 {
-                    await Task.Delay(TimeSpan.FromSeconds(initDetails.Interval ?? 5));
+                    await Task.Delay(TimeSpan.FromSeconds(initDetails.Interval));
                     continue;
                 }
 
-                return new CibaCompletionDetails
-                {
-                    IsAuthenticationPending = false,
-                    Error = ex.ApiError.Error,
-                    ErrorMessage = ex.ApiError.Message,
-                    IsSuccessful = false
-                };
+                completionDetails.IsAuthenticationPending = false;
+                completionDetails.Error = ex.ApiError.Error;
+                completionDetails.ErrorMessage = ex.ApiError.Message;
+                completionDetails.IsSuccessful = false;
             }
         }
+        return completionDetails;
     }
 }

src/Auth0.AspNetCore.Authentication/ClientInitiatedBackChannelAuthentication/IAuth0CibaService.cs

@@ -1,16 +1,21 @@
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 
 using Auth0.AuthenticationApi.Models.Ciba;
 
 namespace Auth0.AspNetCore.Authentication.ClientInitiatedBackChannelAuthentication;
 
-public class CibaInitiationDetails
+public class CibaInitiationDetails : ClientInitiatedBackchannelAuthorizationResponse
 {
-    public string? AuthRequestId { get; init; }
-    public int ExpiresIn { get; init; }
-    public int? Interval { get; init; }
+    /// <summary>
+    /// Indicates whether the polling was successful.
+    /// </summary>
     public bool IsSuccessful { get; init; } = true;
+    
+    /// <summary>
+    /// Indicates any errors that occurred during the initiation of the CIBA request.
+    /// </summary>
     public string? ErrorMessage { get; init; }
 }
 
@@ -70,6 +75,7 @@ public interface IAuth0CibaService
     /// Polls the token endpoint to check the status of a CIBA request and retrieve tokens upon completion.
     /// </summary>
     /// <param name="cibaInitiationDetails">The information required to poll for the CIBA status.</param>
+    /// <param name="cancellationToken"><see cref="CancellationToken"/></param>
     /// <returns>Details about the CIBA completion status or the retrieved tokens.</returns>
-    Task<CibaCompletionDetails> PollForTokensAsync(CibaInitiationDetails cibaInitiationDetails);
+    Task<CibaCompletionDetails> PollForTokensAsync(CibaInitiationDetails cibaInitiationDetails, CancellationToken cancellationToken = default);
 }