chore(backend): silence some more resharper errors

This commit is contained in:
sam 2024-09-14 16:37:52 +02:00
parent 103ba24555
commit 2cef7523d2
Signed by: sam
GPG key ID: B4EF20DDE721CAA1
14 changed files with 38 additions and 35 deletions

View file

@ -1,4 +1,3 @@
using System.Diagnostics.CodeAnalysis;
using Serilog.Events; using Serilog.Events;
namespace Foxnouns.Backend; namespace Foxnouns.Backend;

View file

@ -45,7 +45,7 @@ public class AuthController(Config config, KeyCacheService keyCache, ILogger log
); );
public record CallbackResponse( public record CallbackResponse(
bool HasAccount, // If true, user has an account, but it's deleted bool HasAccount,
[property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)] [property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
string? Ticket, string? Ticket,
[property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)] [property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)]

View file

@ -3,6 +3,7 @@ using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Extensions; using Foxnouns.Backend.Extensions;
using Foxnouns.Backend.Services; using Foxnouns.Backend.Services;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
using JetBrains.Annotations;
using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using NodaTime; using NodaTime;
@ -11,7 +12,7 @@ namespace Foxnouns.Backend.Controllers.Authentication;
[Route("/api/v2/auth/discord")] [Route("/api/v2/auth/discord")]
public class DiscordAuthController( public class DiscordAuthController(
Config config, [UsedImplicitly] Config config,
ILogger logger, ILogger logger,
IClock clock, IClock clock,
DatabaseContext db, DatabaseContext db,
@ -26,14 +27,15 @@ public class DiscordAuthController(
// TODO: duplicating attribute doesn't work, find another way to mark both as possible response // TODO: duplicating attribute doesn't work, find another way to mark both as possible response
// leaving it here for documentation purposes // leaving it here for documentation purposes
[ProducesResponseType<AuthController.CallbackResponse>(StatusCodes.Status200OK)] [ProducesResponseType<AuthController.CallbackResponse>(StatusCodes.Status200OK)]
public async Task<IActionResult> CallbackAsync([FromBody] AuthController.CallbackRequest req, CancellationToken ct = default) public async Task<IActionResult> CallbackAsync([FromBody] AuthController.CallbackRequest req,
CancellationToken ct = default)
{ {
CheckRequirements(); CheckRequirements();
await keyCacheService.ValidateAuthStateAsync(req.State, ct); await keyCacheService.ValidateAuthStateAsync(req.State, ct);
var remoteUser = await remoteAuthService.RequestDiscordTokenAsync(req.Code, req.State, ct); var remoteUser = await remoteAuthService.RequestDiscordTokenAsync(req.Code, req.State, ct);
var user = await authService.AuthenticateUserAsync(AuthType.Discord, remoteUser.Id, ct: ct); var user = await authService.AuthenticateUserAsync(AuthType.Discord, remoteUser.Id, ct: ct);
if (user != null) return Ok(await GenerateUserTokenAsync(user,ct)); if (user != null) return Ok(await GenerateUserTokenAsync(user, ct));
_logger.Debug("Discord user {Username} ({Id}) authenticated with no local account", remoteUser.Username, _logger.Debug("Discord user {Username} ({Id}) authenticated with no local account", remoteUser.Username,
remoteUser.Id); remoteUser.Id);
@ -53,24 +55,25 @@ public class DiscordAuthController(
[HttpPost("register")] [HttpPost("register")]
[ProducesResponseType<AuthController.AuthResponse>(StatusCodes.Status200OK)] [ProducesResponseType<AuthController.AuthResponse>(StatusCodes.Status200OK)]
public async Task<IActionResult> RegisterAsync([FromBody] AuthController.OauthRegisterRequest req, CancellationToken ct = default) public async Task<IActionResult> RegisterAsync([FromBody] AuthController.OauthRegisterRequest req)
{ {
var remoteUser = await keyCacheService.GetKeyAsync<RemoteAuthService.RemoteUser>($"discord:{req.Ticket}",ct:ct); var remoteUser = await keyCacheService.GetKeyAsync<RemoteAuthService.RemoteUser>($"discord:{req.Ticket}");
if (remoteUser == null) throw new ApiError.BadRequest("Invalid ticket", "ticket", req.Ticket); if (remoteUser == null) throw new ApiError.BadRequest("Invalid ticket", "ticket", req.Ticket);
if (await db.AuthMethods.AnyAsync(a => a.AuthType == AuthType.Discord && a.RemoteId == remoteUser.Id, ct)) if (await db.AuthMethods.AnyAsync(a => a.AuthType == AuthType.Discord && a.RemoteId == remoteUser.Id))
{ {
_logger.Error("Discord user {Id} has valid ticket but is already linked to an existing account", _logger.Error("Discord user {Id} has valid ticket but is already linked to an existing account",
remoteUser.Id); remoteUser.Id);
throw new FoxnounsError("Discord ticket was issued for user with existing link"); throw new ApiError.BadRequest("Invalid ticket", "ticket", req.Ticket);
} }
var user = await authService.CreateUserWithRemoteAuthAsync(req.Username, AuthType.Discord, remoteUser.Id, var user = await authService.CreateUserWithRemoteAuthAsync(req.Username, AuthType.Discord, remoteUser.Id,
remoteUser.Username, ct: ct); remoteUser.Username);
return Ok(await GenerateUserTokenAsync(user, ct)); return Ok(await GenerateUserTokenAsync(user));
} }
private async Task<AuthController.CallbackResponse> GenerateUserTokenAsync(User user, CancellationToken ct = default) private async Task<AuthController.CallbackResponse> GenerateUserTokenAsync(User user,
CancellationToken ct = default)
{ {
var frontendApp = await db.GetFrontendApplicationAsync(ct); var frontendApp = await db.GetFrontendApplicationAsync(ct);
_logger.Debug("Logging user {Id} in with Discord", user.Id); _logger.Debug("Logging user {Id} in with Discord", user.Id);

View file

@ -3,6 +3,7 @@ using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Extensions; using Foxnouns.Backend.Extensions;
using Foxnouns.Backend.Services; using Foxnouns.Backend.Services;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
using JetBrains.Annotations;
using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using NodaTime; using NodaTime;
@ -11,8 +12,8 @@ namespace Foxnouns.Backend.Controllers.Authentication;
[Route("/api/v2/auth/email")] [Route("/api/v2/auth/email")]
public class EmailAuthController( public class EmailAuthController(
[UsedImplicitly] Config config,
DatabaseContext db, DatabaseContext db,
Config config,
AuthService authService, AuthService authService,
MailService mailService, MailService mailService,
KeyCacheService keyCacheService, KeyCacheService keyCacheService,

View file

@ -17,7 +17,7 @@ public partial class InternalController(DatabaseContext db) : ControllerBase
private static string GetCleanedTemplate(string template) private static string GetCleanedTemplate(string template)
{ {
if (template.StartsWith("api/v2")) template = template.Substring("api/v2".Length); if (template.StartsWith("api/v2")) template = template["api/v2".Length..];
template = PathVarRegex() template = PathVarRegex()
.Replace(template, "{id}") // Replace all path variables (almost always IDs) with `{id}` .Replace(template, "{id}") // Replace all path variables (almost always IDs) with `{id}`
.Replace("@me", "{id}"); // Also replace hardcoded `@me` with `{id}` .Replace("@me", "{id}"); // Also replace hardcoded `@me` with `{id}`
@ -50,7 +50,7 @@ public partial class InternalController(DatabaseContext db) : ControllerBase
Snowflake? UserId, Snowflake? UserId,
string Template); string Template);
private static Endpoint? GetEndpoint(HttpContext httpContext, string url, string requestMethod) private static RouteEndpoint? GetEndpoint(HttpContext httpContext, string url, string requestMethod)
{ {
var endpointDataSource = httpContext.RequestServices.GetService<EndpointDataSource>(); var endpointDataSource = httpContext.RequestServices.GetService<EndpointDataSource>();
if (endpointDataSource == null) return null; if (endpointDataSource == null) return null;
@ -60,7 +60,7 @@ public partial class InternalController(DatabaseContext db) : ControllerBase
{ {
if (endpoint.RoutePattern.RawText == null) continue; if (endpoint.RoutePattern.RawText == null) continue;
var templateMatcher = new TemplateMatcher(TemplateParser.Parse(endpoint.RoutePattern.RawText), new()); var templateMatcher = new TemplateMatcher(TemplateParser.Parse(endpoint.RoutePattern.RawText), new RouteValueDictionary());
if (!templateMatcher.TryMatch(url, new())) continue; if (!templateMatcher.TryMatch(url, new())) continue;
var httpMethodAttribute = endpoint.Metadata.GetMetadata<HttpMethodAttribute>(); var httpMethodAttribute = endpoint.Metadata.GetMetadata<HttpMethodAttribute>();
if (httpMethodAttribute != null && if (httpMethodAttribute != null &&

View file

@ -88,19 +88,17 @@ public class MembersController(
[HttpDelete("/api/v2/users/@me/members/{memberRef}")] [HttpDelete("/api/v2/users/@me/members/{memberRef}")]
[Authorize("member.update")] [Authorize("member.update")]
public async Task<IActionResult> DeleteMemberAsync(string memberRef, CancellationToken ct = default) public async Task<IActionResult> DeleteMemberAsync(string memberRef)
{ {
var member = await db.ResolveMemberAsync(CurrentUser!.Id, memberRef, ct); var member = await db.ResolveMemberAsync(CurrentUser!.Id, memberRef);
var deleteCount = await db.Members.Where(m => m.UserId == CurrentUser!.Id && m.Id == member.Id) var deleteCount = await db.Members.Where(m => m.UserId == CurrentUser!.Id && m.Id == member.Id)
.ExecuteDeleteAsync(ct); .ExecuteDeleteAsync();
if (deleteCount == 0) if (deleteCount == 0)
{ {
_logger.Warning("Successfully resolved member {Id} but could not delete them", member.Id); _logger.Warning("Successfully resolved member {Id} but could not delete them", member.Id);
return NoContent(); return NoContent();
} }
await db.SaveChangesAsync(ct);
if (member.Avatar != null) await objectStorageService.DeleteMemberAvatarAsync(member.Id, member.Avatar); if (member.Avatar != null) await objectStorageService.DeleteMemberAvatarAsync(member.Id, member.Avatar);
return NoContent(); return NoContent();
} }

View file

@ -1,7 +1,6 @@
using System.Security.Cryptography; using System.Security.Cryptography;
using Foxnouns.Backend.Database.Models; using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
using Microsoft.AspNetCore.Mvc.Formatters;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using NodaTime; using NodaTime;
@ -95,7 +94,7 @@ public static class DatabaseQueryExtensions
{ {
Id = new Snowflake(0), Id = new Snowflake(0),
ClientId = RandomNumberGenerator.GetHexString(32, true), ClientId = RandomNumberGenerator.GetHexString(32, true),
ClientSecret = AuthUtils.RandomToken(48), ClientSecret = AuthUtils.RandomToken(),
Name = "pronouns.cc", Name = "pronouns.cc",
Scopes = ["*"], Scopes = ["*"],
RedirectUris = [], RedirectUris = [],

View file

@ -9,7 +9,7 @@ public class Application : BaseModel
public required string ClientSecret { get; init; } public required string ClientSecret { get; init; }
public required string Name { get; init; } public required string Name { get; init; }
public required string[] Scopes { get; init; } public required string[] Scopes { get; init; }
public required string[] RedirectUris { get; set; } public required string[] RedirectUris { get; init; }
public static Application Create(ISnowflakeGenerator snowflakeGenerator, string name, string[] scopes, public static Application Create(ISnowflakeGenerator snowflakeGenerator, string name, string[] scopes,
string[] redirectUrls) string[] redirectUrls)

View file

@ -1,6 +1,4 @@
using System.Collections.ObjectModel;
using System.Net; using System.Net;
using Foxnouns.Backend.Middleware;
using Microsoft.AspNetCore.Mvc.ModelBinding; using Microsoft.AspNetCore.Mvc.ModelBinding;
using Newtonsoft.Json; using Newtonsoft.Json;
using Newtonsoft.Json.Linq; using Newtonsoft.Json.Linq;
@ -51,7 +49,7 @@ public class ApiError(string message, HttpStatusCode? statusCode = null, ErrorCo
{ {
{ "status", (int)HttpStatusCode.BadRequest }, { "status", (int)HttpStatusCode.BadRequest },
{ "message", Message }, { "message", Message },
{ "code", ErrorCode.BadRequest.ToString() } { "code", "BAD_REQUEST" }
}; };
if (errors == null) return o; if (errors == null) return o;
@ -84,7 +82,7 @@ public class ApiError(string message, HttpStatusCode? statusCode = null, ErrorCo
{ {
{ "status", (int)HttpStatusCode.BadRequest }, { "status", (int)HttpStatusCode.BadRequest },
{ "message", Message }, { "message", Message },
{ "code", ErrorCode.BadRequest.ToString() } { "code", "BAD_REQUEST" }
}; };
if (modelState == null) return o; if (modelState == null) return o;

View file

@ -10,6 +10,7 @@
<PackageReference Include="Coravel.Mailer" Version="5.0.1" /> <PackageReference Include="Coravel.Mailer" Version="5.0.1" />
<PackageReference Include="EFCore.NamingConventions" Version="8.0.3" /> <PackageReference Include="EFCore.NamingConventions" Version="8.0.3" />
<PackageReference Include="EntityFrameworkCore.Exceptions.PostgreSQL" Version="8.1.2" /> <PackageReference Include="EntityFrameworkCore.Exceptions.PostgreSQL" Version="8.1.2" />
<PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
<PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="8.0.7" /> <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="8.0.7" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.7" /> <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.7" />
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.7" /> <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.7" />

View file

@ -1,7 +1,6 @@
using System.Net; using System.Net;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
using Newtonsoft.Json; using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace Foxnouns.Backend.Middleware; namespace Foxnouns.Backend.Middleware;

View file

@ -74,6 +74,7 @@ public class AuthService(IClock clock, DatabaseContext db, ISnowflakeGenerator s
/// </summary> /// </summary>
/// <param name="email">The user's email address</param> /// <param name="email">The user's email address</param>
/// <param name="password">The user's password, in plain text</param> /// <param name="password">The user's password, in plain text</param>
/// <param name="ct">Cancellation token</param>
/// <returns>A tuple of the authenticated user and whether multi-factor authentication is required</returns> /// <returns>A tuple of the authenticated user and whether multi-factor authentication is required</returns>
/// <exception cref="ApiError.NotFound">Thrown if the email address is not associated with any user /// <exception cref="ApiError.NotFound">Thrown if the email address is not associated with any user
/// or if the password is incorrect</exception> /// or if the password is incorrect</exception>

View file

@ -1,6 +1,5 @@
using Foxnouns.Backend.Database; using Foxnouns.Backend.Database;
using Foxnouns.Backend.Database.Models; using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Utils;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Newtonsoft.Json; using Newtonsoft.Json;
using NodaTime; using NodaTime;

View file

@ -1,5 +1,5 @@
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
using System.Web; using JetBrains.Annotations;
namespace Foxnouns.Backend.Services; namespace Foxnouns.Backend.Services;
@ -27,7 +27,8 @@ public class RemoteAuthService(Config config, ILogger logger)
if (!resp.IsSuccessStatusCode) if (!resp.IsSuccessStatusCode)
{ {
var respBody = await resp.Content.ReadAsStringAsync(ct); var respBody = await resp.Content.ReadAsStringAsync(ct);
_logger.Error("Received error status {StatusCode} when exchanging OAuth token: {ErrorBody}", (int)resp.StatusCode, respBody); _logger.Error("Received error status {StatusCode} when exchanging OAuth token: {ErrorBody}",
(int)resp.StatusCode, respBody);
throw new FoxnounsError("Invalid Discord OAuth response"); throw new FoxnounsError("Invalid Discord OAuth response");
} }
@ -46,10 +47,14 @@ public class RemoteAuthService(Config config, ILogger logger)
return new RemoteUser(user.id, user.username); return new RemoteUser(user.id, user.username);
} }
[SuppressMessage("ReSharper", "InconsistentNaming")] [SuppressMessage("ReSharper", "InconsistentNaming",
Justification = "Easier to use snake_case here, rather than passing in JSON converter options")]
[UsedImplicitly]
private record DiscordTokenResponse(string access_token, string token_type); private record DiscordTokenResponse(string access_token, string token_type);
[SuppressMessage("ReSharper", "InconsistentNaming")] [SuppressMessage("ReSharper", "InconsistentNaming",
Justification = "Easier to use snake_case here, rather than passing in JSON converter options")]
[UsedImplicitly]
private record DiscordUserResponse(string id, string username); private record DiscordUserResponse(string id, string username);
public record RemoteUser(string Id, string Username); public record RemoteUser(string Id, string Username);