AsyncEnumerable responses and doc cleanup

Author: hhvrc

API/Controller/Account/Activate.cs

@@ -1,7 +1,7 @@
 using System.Net.Mime;
 using Microsoft.AspNetCore.Mvc;
 using Asp.Versioning;
-using OpenShock.API.Models.Requests;
+using OpenShock.Common.Errors;
 using OpenShock.Common.Problems;
 
 namespace OpenShock.API.Controller.Account;
@@ -14,12 +14,12 @@ public sealed partial class AccountController
     /// <response code="200"></response>
     [HttpPost("activate")]
     [ProducesResponseType(StatusCodes.Status200OK)]
-    [ProducesResponseType<OpenShockProblem>(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)]
+    [ProducesResponseType<OpenShockProblem>(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)]
     [MapToApiVersion("1")]
     public async Task<IActionResult> Activate([FromQuery(Name = "token")] string token, CancellationToken cancellationToken)
     {
         bool ok = await _accountService.TryActivateAccountAsync(token, cancellationToken);
 
-        return Ok();
+        return ok ? Ok() : Problem(AccountError.AccountActivationNotFound);
     }
 }

API/Controller/Account/Authenticated/OAuthConnectionsList.cs

@@ -1,4 +1,6 @@
-using Microsoft.AspNetCore.Mvc;
+using System.Net.Mime;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.EntityFrameworkCore;
 using OpenShock.API.Models.Response;
 using OpenShock.API.Services.OAuthConnection;
 
@@ -12,19 +14,18 @@ public sealed partial class AuthenticatedAccountController
     /// <returns>Array of connections with provider key, external id, display name and link time.</returns>
     /// <response code="200">Returns the list of connections.</response>
     [HttpGet("connections")]
-    [ProducesResponseType(StatusCodes.Status200OK)]
-    public async Task<OAuthConnectionResponse[]> ListOAuthConnections([FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken)
+    [ProducesResponseType<OAuthConnectionResponse[]>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    public IActionResult ListOAuthConnections([FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken)
     {
-        var connections = await connectionService.GetConnectionsAsync(CurrentUser.Id, cancellationToken);
-
-        return connections
+        return Ok(connectionService
+            .GetConnectionsAsNonTrackingQuery(CurrentUser.Id, cancellationToken)
             .Select(c => new OAuthConnectionResponse
             {
                 ProviderKey = c.ProviderKey,
                 ExternalId = c.ExternalId,
                 DisplayName = c.DisplayName,
                 LinkedAt = c.CreatedAt
             })
-            .ToArray();
+            .AsAsyncEnumerable());
     }
 }

API/Services/OAuthConnection/IOAuthConnectionService.cs

@@ -7,7 +7,7 @@ namespace OpenShock.API.Services.OAuthConnection;
 /// </summary>
 public interface IOAuthConnectionService
 {
-    Task<UserOAuthConnection[]> GetConnectionsAsync(Guid userId, CancellationToken cancellationToken = default);
+    IQueryable<UserOAuthConnection> GetConnectionsAsNonTrackingQuery(Guid userId, CancellationToken cancellationToken = default);
     Task<UserOAuthConnection?> GetByProviderExternalIdAsync(string provider, string providerAccountId, CancellationToken cancellationToken = default);
     Task<bool> ConnectionExistsAsync(string provider, string providerAccountId, CancellationToken cancellationToken = default);
     Task<bool> HasConnectionAsync(Guid userId, string provider, CancellationToken cancellationToken = default);

API/Services/OAuthConnection/OAuthConnectionService.cs

@@ -15,12 +15,11 @@ public OAuthConnectionService(OpenShockContext db, ILogger<OAuthConnectionServic
         _logger = logger;
     }
 
-    public async Task<UserOAuthConnection[]> GetConnectionsAsync(Guid userId, CancellationToken cancellationToken)
+    public IQueryable<UserOAuthConnection> GetConnectionsAsNonTrackingQuery(Guid userId, CancellationToken cancellationToken)
     {
-        return await _db.UserOAuthConnections
+        return _db.UserOAuthConnections
             .AsNoTracking()
-            .Where(c => c.UserId == userId)
-            .ToArrayAsync(cancellationToken);
+            .Where(c => c.UserId == userId);
     }
 
     public async Task<UserOAuthConnection?> GetByProviderExternalIdAsync(string provider, string providerAccountId, CancellationToken cancellationToken)

Common/Errors/AccountError.cs

@@ -26,6 +26,7 @@ public static class AccountError
         "Account.Username.RecentlyChanged", "You have recently changed your username. You can only change your username every 7 days", HttpStatusCode.Forbidden);
 
     public static OpenShockProblem AccountNotActivated => new OpenShockProblem("Account.AccountNotActivated", "Your account has not been activated", HttpStatusCode.Unauthorized);
+    public static OpenShockProblem AccountActivationNotFound => new OpenShockProblem("Account.Activation.NotFound", "There is no account activation request matching the supplied token", HttpStatusCode.BadRequest);
     public static OpenShockProblem AccountDeactivated => new OpenShockProblem("Account.Deactivated", "Your account has been deactivated", HttpStatusCode.Unauthorized);
 
     public static OpenShockProblem AccountOAuthOnly => new OpenShockProblem("Account.OAuthOnly", "This account is only accessible via OAuth", HttpStatusCode.Unauthorized);