feat: .NET 10

.github/workflows/ci-build.yml

@@ -33,7 +33,7 @@ name: ci-build
 
 env:
   REGISTRY: ghcr.io
-  DOTNET_VERSION: 9.0.x
+  DOTNET_VERSION: 10.0.x
 
 jobs:
 
@@ -60,7 +60,7 @@ jobs:
       - name: Run ${{ matrix.name }} tests
         run: |
           set -euo pipefail
-          dotnet test -c Release ${{ matrix.project }}
+          dotnet test -c Release --project ${{ matrix.project }}
 
   build:
     name: Build (${{ matrix.image }})

.github/workflows/ci-tag.yml

@@ -7,7 +7,7 @@ on:
 name: ci-tag
 
 env:
-  DOTNET_VERSION: 9.0.x
+  DOTNET_VERSION: 10.0.x
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository_owner }}/api
 

.github/workflows/codeql.yml

@@ -9,7 +9,7 @@ on:
     - cron: '0 6 * * 1'
 
 env:
-  DOTNET_VERSION: 9.x.x
+  DOTNET_VERSION: 10.x.x
 
 jobs:
   analyze:

API.IntegrationTests/Tests/LcgAssignmentTests.cs

@@ -66,7 +66,7 @@ public async Task Teardown()
         await db.Devices.Where(x => x.Id == _hubId).ExecuteDeleteAsync();
         await db.Users.Where(x => x.Id == _userId).ExecuteDeleteAsync();
 
-        var allLcg = await lcgNodesCollection.ToArrayAsync();
+        var allLcg = await lcgNodesCollection.ToListAsync();
         await lcgNodesCollection.DeleteAsync(allLcg);
     }
 

API/Controller/Admin/GetOnlineDevices.cs

@@ -22,7 +22,7 @@ public async Task<IActionResult> GetOnlineDevices()
     {
         var devicesOnline = _redis.RedisCollection<DeviceOnline>(false);
 
-        var allOnlineDevices = await devicesOnline.ToArrayAsync();
+        var allOnlineDevices = await devicesOnline.ToListAsync();
         var dbLookup = await _db.Devices
             .Where(x => allOnlineDevices.Select(y => y.Id).Contains(x.Id))
             .Select(x => new

API/Controller/Admin/_ApiController.cs

@@ -9,6 +9,7 @@ namespace OpenShock.API.Controller.Admin;
 
 [ApiController]
 [Tags("Admin")]
+[EndpointGroupName("admin")]
 [Route("/{version:apiVersion}/admin")]
 [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie, Roles = "Admin")]
 public sealed partial class AdminController : AuthenticatedSessionControllerBase

API/Controller/Device/Pair.cs

@@ -22,11 +22,29 @@ public sealed partial class DeviceController
     [AllowAnonymous]
     [MapToApiVersion("1")]
     [HttpGet("pair/{pairCode}", Name = "Pair")]
-    [HttpGet("~/{version:apiVersion}/pair/{pairCode}", Name = "Pair_DEPRECATED")] // Backwards compatibility
+    [EndpointName("PairDeviceByCode")]
     [EnableRateLimiting("auth")]
     [ProducesResponseType<LegacyDataResponse<string>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     [ProducesResponseType<OpenShockProblem>(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PairCodeNotFound
     public async Task<IActionResult> Pair([FromRoute] string pairCode)
+    {
+        return await PairInternal(pairCode);
+    }
+
+    /// <summary>
+    /// Pair a device with a pair code, legacy endpoint kept for backwards compatibility
+    /// </summary>
+    [AllowAnonymous]
+    [MapToApiVersion("1")]
+    [HttpGet("~/{version:apiVersion}/pair/{pairCode}")]
+    [ApiExplorerSettings(IgnoreApi = true)]
+    [EnableRateLimiting("auth")]
+    public async Task<IActionResult> PairDeprecated([FromRoute] string pairCode)
+    {
+        return await PairInternal(pairCode);
+    }
+
+    public async Task<IActionResult> PairInternal(string pairCode)
     {
         var devicePairs = _redis.RedisCollection<DevicePair>();
 

API/Controller/Devices/DevicesController.cs

@@ -25,12 +25,12 @@ public sealed partial class DevicesController
     /// <response code="200">All devices for the current user</response>
     [HttpGet]
     [MapToApiVersion("1")]
-    [ProducesResponseType<LegacyDataResponse<Models.Response.ResponseDevice[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<Models.Response.DeviceResponse[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     public IActionResult ListDevices()
     {
         var devices = _db.Devices
             .Where(x => x.OwnerId == CurrentUser.Id)
-            .Select(x => new Models.Response.ResponseDevice
+            .Select(x => new Models.Response.DeviceResponse
             {
                 Id = x.Id,
                 Name = x.Name,
@@ -47,7 +47,7 @@ public IActionResult ListDevices()
     /// <param name="deviceId"></param>
     /// <response code="200">The device</response>
     [HttpGet("{deviceId}")]
-    [ProducesResponseType<LegacyDataResponse<Models.Response.ResponseDeviceWithToken>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<Models.Response.DeviceWithTokenResponse>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     [ProducesResponseType<OpenShockProblem>(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound
     [MapToApiVersion("1")]
     public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
@@ -56,7 +56,7 @@ public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
 
 
         var device = await _db.Devices.Where(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId)
-            .Select(x => new Models.Response.ResponseDeviceWithToken
+            .Select(x => new Models.Response.DeviceWithTokenResponse
             {
                 Id = x.Id,
                 Name = x.Name,

API/Controller/OAuth/Authorize.cs

@@ -20,7 +20,6 @@ public sealed partial class OAuthController
     /// <response code="400">Unsupported or misconfigured provider.</response>
     [EnableRateLimiting("auth")]
     [HttpPost("{provider}/authorize")]
-    [ApiExplorerSettings(IgnoreApi = true)]
     public async Task<IActionResult> OAuthAuthorize([FromRoute] string provider, [FromQuery(Name="flow"), Required] OAuthFlow flow)
     {
         if (!await _schemeProvider.IsSupportedOAuthScheme(provider))

API/Controller/OAuth/HandOff.cs

@@ -21,7 +21,6 @@ public sealed partial class OAuthController
     /// </remarks>
     [EnableRateLimiting("auth")]
     [HttpGet("{provider}/handoff")]
-    [ApiExplorerSettings(IgnoreApi = true)]
     public async Task<IActionResult> OAuthHandOff(
         [FromRoute] string provider,
         [FromServices] IOAuthConnectionService connectionService,

API/Controller/OAuth/SignupFinalize.cs

@@ -26,7 +26,6 @@ public sealed partial class OAuthController
     /// <param name="cancellationToken"></param>
     [EnableRateLimiting("auth")]
     [HttpPost("{provider}/signup-finalize")]
-    [ApiExplorerSettings(IgnoreApi = true)]
     public async Task<IActionResult> OAuthSignupFinalize(
         [FromRoute] string provider,
         [FromBody] OAuthFinalizeRequest body,

API/Controller/OAuth/SignupGetData.cs

@@ -22,7 +22,6 @@ public sealed partial class OAuthController
     [ResponseCache(NoStore = true)]
     [EnableRateLimiting("auth")]
     [HttpGet("{provider}/signup-data")]
-    [ApiExplorerSettings(IgnoreApi = true)]
     public async Task<IActionResult> OAuthSignupGetData([FromRoute] string provider)
     {
         if (User.HasOpenShockUserIdentity())

API/Controller/OAuth/_ApiController.cs

@@ -13,9 +13,8 @@ namespace OpenShock.API.Controller.OAuth;
 /// OAuth management endpoints (provider listing, authorize, data handoff).
 /// </summary>
 [ApiController]
-[Tags("OAuth")]
-[ApiVersion("1")]
-[Route("/{version:apiVersion}/oauth")]
+[EndpointGroupName("oauth")]
+[Route("/{version:apiVersion}/oauth"), ApiVersion("1")]
 public sealed partial class OAuthController : OpenShockControllerBase
 {
     private readonly IAccountService _accountService;

API/Controller/Sessions/ListSessions.cs

@@ -1,5 +1,4 @@
 using System.Net.Mime;
-using System.Runtime.CompilerServices;
 using Microsoft.AspNetCore.Mvc;
 using OpenShock.API.Models.Response;
 
@@ -9,11 +8,9 @@ public sealed partial class SessionsController
 {
     [HttpGet]
     [ProducesResponseType<LoginSessionResponse[]>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
-    public async IAsyncEnumerable<LoginSessionResponse> ListSessions([EnumeratorCancellation] CancellationToken cancellationToken)
+    public IAsyncEnumerable<LoginSessionResponse> ListSessions()
     {
-        await foreach (var session in _sessionService.ListSessionsByUserIdAsync(CurrentUser.Id).WithCancellation(cancellationToken))
-        {
-            yield return LoginSessionResponse.MapFrom(session);
-        }
+        return _sessionService.ListSessionsByUserIdAsync(CurrentUser.Id)
+            .Select(LoginSessionResponse.MapFrom);
     }
 }

API/Controller/Shockers/ListShockers.cs

@@ -15,12 +15,12 @@ public sealed partial class ShockerController
     /// <response code="200">The shockers were successfully retrieved.</response>
     [HttpGet("own")]
     [MapToApiVersion("1")]
-    [ProducesResponseType<LegacyDataResponse<ResponseDeviceWithShockers[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<DeviceWithShockersResponse[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     public IActionResult ListShockers()
     {
         var shockers = _db.Devices
             .Where(x => x.OwnerId == CurrentUser.Id)
-            .OrderBy(x => x.CreatedAt).Select(x => new ResponseDeviceWithShockers
+            .OrderBy(x => x.CreatedAt).Select(x => new DeviceWithShockersResponse
             {
                 Id = x.Id,
                 Name = x.Name,

API/Models/Response/ResponseDevice.cs → API/Models/Response/DeviceResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public class ResponseDevice
+public class DeviceResponse
 {
     public required Guid Id { get; init; }
     public required string Name { get; init; }

API/Models/Response/ResponseDeviceWithShockers.cs → API/Models/Response/DeviceWithShockersResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public sealed class ResponseDeviceWithShockers : ResponseDevice
+public sealed class DeviceWithShockersResponse : DeviceResponse
 {
     public required ShockerResponse[] Shockers { get; init; }
 }

API/Models/Response/ResponseDeviceWithToken.cs → API/Models/Response/DeviceWithTokenResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public sealed class ResponseDeviceWithToken : ResponseDevice
+public sealed class DeviceWithTokenResponse : DeviceResponse
 {
     public required string? Token { get; init; }
 }

API/Program.cs

@@ -12,10 +12,10 @@
 using OpenShock.Common;
 using OpenShock.Common.Extensions;
 using OpenShock.Common.Hubs;
+using OpenShock.Common.OpenAPI;
 using OpenShock.Common.Services;
 using OpenShock.Common.Services.Device;
 using OpenShock.Common.Services.Ota;
-using OpenShock.Common.Swagger;
 using Serilog;
 using OAuthConstants = OpenShock.API.OAuth.OAuthConstants;
 
@@ -103,7 +103,7 @@ static void DefaultOptions(RemoteAuthenticationOptions options, string provider)
 builder.Services.AddScoped<IUserService, UserService>();
 builder.Services.AddScoped<ILCGNodeProvisioner, LCGNodeProvisioner>();
 
-builder.AddSwaggerExt<Program>();
+builder.AddOpenApiExt<Program>();
 
 builder.AddCloudflareTurnstileService();
 builder.AddEmailService();

API/Services/LCGNodeProvisioner/LCGNodeProvisioner.cs

@@ -44,9 +44,9 @@ public LCGNodeProvisioner(IRedisConnectionProvider redisConnectionProvider, IWeb
         // Load all nodes for our environment
         var nodes = await _lcgNodes
             .Where(x => x.Environment == _environmentName)
-            .ToArrayAsync();
+            .ToListAsync();
 
-        if(nodes.Length < 1)
+        if(nodes.Count < 1)
         {
             _logger.LogWarning("No LCG nodes available after filtering by environment [{Environment}]!", _environmentName);
             return null;

Common/Common.csproj

@@ -13,6 +13,7 @@
     </PackageReference>
     <PackageReference Include="MessagePack" />
     <PackageReference Include="Microsoft.AspNetCore.DataProtection.EntityFrameworkCore" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" />
     <PackageReference Include="Microsoft.Extensions.Caching.Hybrid" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" />
@@ -31,7 +32,6 @@
     <PackageReference Include="OneOf" />
     <PackageReference Include="Serilog.AspNetCore" />
     <PackageReference Include="Serilog.Sinks.OpenTelemetry" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" />
     <PackageReference Include="Z.EntityFramework.Plus.EFCore" />
   </ItemGroup>
 

Common/DataAnnotations/EmailAddressAttribute.cs

@@ -1,9 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 using System.Net.Mail;
-using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Models;
 using OpenShock.Common.Constants;
-using OpenShock.Common.DataAnnotations.Interfaces;
 
 namespace OpenShock.Common.DataAnnotations;
 
@@ -13,8 +10,8 @@ namespace OpenShock.Common.DataAnnotations;
 /// <remarks>
 /// Inherits from <see cref="ValidationAttribute"/>.
 /// </remarks>
-[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false)]
-public sealed class EmailAddressAttribute : ValidationAttribute, IParameterAttribute
+[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter)]
+public sealed class EmailAddressAttribute : ValidationAttribute
 {
     /// <summary>
     /// Example value used to generate OpenApi documentation.
@@ -55,15 +52,4 @@ public sealed class EmailAddressAttribute : ValidationAttribute, IParameterAttri
 
         return ValidationResult.Success;
     }
-
-    /// <inheritdoc/>
-    public void Apply(OpenApiSchema schema)
-    {
-        //if (ShouldValidate) schema.Pattern = ???;
-
-        schema.Example = new OpenApiString(ExampleValue);
-    }
-
-    /// <inheritdoc/>
-    public void Apply(OpenApiParameter parameter) => Apply(parameter.Schema);
 }