diff --git a/Foxnouns.Backend/Controllers/Authentication/AuthController.cs b/Foxnouns.Backend/Controllers/Authentication/AuthController.cs index db2e21f..6565fba 100644 --- a/Foxnouns.Backend/Controllers/Authentication/AuthController.cs +++ b/Foxnouns.Backend/Controllers/Authentication/AuthController.cs @@ -9,13 +9,11 @@ namespace Foxnouns.Backend.Controllers.Authentication; [Route("/api/v2/auth")] public class AuthController(Config config, KeyCacheService keyCacheSvc, ILogger logger) : ApiControllerBase { - private readonly ILogger _logger = logger.ForContext(); - [HttpPost("urls")] [ProducesResponseType(StatusCodes.Status200OK)] public async Task UrlsAsync() { - _logger.Debug("Generating auth URLs for Discord: {Discord}, Google: {Google}, Tumblr: {Tumblr}", + logger.Debug("Generating auth URLs for Discord: {Discord}, Google: {Google}, Tumblr: {Tumblr}", config.DiscordAuth.Enabled, config.GoogleAuth.Enabled, config.TumblrAuth.Enabled); diff --git a/Foxnouns.Backend/Controllers/Authentication/DiscordAuthController.cs b/Foxnouns.Backend/Controllers/Authentication/DiscordAuthController.cs index d717aba..577231c 100644 --- a/Foxnouns.Backend/Controllers/Authentication/DiscordAuthController.cs +++ b/Foxnouns.Backend/Controllers/Authentication/DiscordAuthController.cs @@ -20,8 +20,6 @@ public class DiscordAuthController( RemoteAuthService remoteAuthSvc, UserRendererService userRendererSvc) : ApiControllerBase { - private readonly ILogger _logger = logger.ForContext(); - [HttpPost("callback")] // TODO: duplicating attribute doesn't work, find another way to mark both as possible response // leaving it here for documentation purposes @@ -36,7 +34,7 @@ public class DiscordAuthController( var user = await authSvc.AuthenticateUserAsync(AuthType.Discord, remoteUser.Id); if (user != null) return Ok(await GenerateUserTokenAsync(user)); - _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); var ticket = AuthUtils.RandomToken(); @@ -53,7 +51,7 @@ public class DiscordAuthController( 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)) { - _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); throw new FoxnounsError("Discord ticket was issued for user with existing link"); } @@ -67,13 +65,13 @@ public class DiscordAuthController( private async Task GenerateUserTokenAsync(User user) { var frontendApp = await db.GetFrontendApplicationAsync(); - _logger.Debug("Logging user {Id} in with Discord", user.Id); + logger.Debug("Logging user {Id} in with Discord", user.Id); var (tokenStr, token) = authSvc.GenerateToken(user, frontendApp, ["*"], clock.GetCurrentInstant() + Duration.FromDays(365)); db.Add(token); - _logger.Debug("Generated token {TokenId} for {UserId}", user.Id, token.Id); + logger.Debug("Generated token {TokenId} for {UserId}", user.Id, token.Id); await db.SaveChangesAsync(); diff --git a/Foxnouns.Backend/Controllers/Authentication/EmailAuthController.cs b/Foxnouns.Backend/Controllers/Authentication/EmailAuthController.cs index 19dfc2f..e1146c5 100644 --- a/Foxnouns.Backend/Controllers/Authentication/EmailAuthController.cs +++ b/Foxnouns.Backend/Controllers/Authentication/EmailAuthController.cs @@ -13,8 +13,6 @@ public class EmailAuthController( IClock clock, ILogger logger) : ApiControllerBase { - private readonly ILogger _logger = logger.ForContext(); - [HttpPost("login")] [ProducesResponseType(StatusCodes.Status200OK)] public async Task LoginAsync([FromBody] LoginRequest req) @@ -25,13 +23,13 @@ public class EmailAuthController( var frontendApp = await db.GetFrontendApplicationAsync(); - _logger.Debug("Logging user {Id} in with email and password", user.Id); + logger.Debug("Logging user {Id} in with email and password", user.Id); var (tokenStr, token) = authSvc.GenerateToken(user, frontendApp, ["*"], clock.GetCurrentInstant() + Duration.FromDays(365)); db.Add(token); - _logger.Debug("Generated token {TokenId} for {UserId}", token.Id, user.Id); + logger.Debug("Generated token {TokenId} for {UserId}", user.Id, token.Id); await db.SaveChangesAsync(); diff --git a/Foxnouns.Backend/Controllers/DebugController.cs b/Foxnouns.Backend/Controllers/DebugController.cs index a8d3ab2..94a0ff2 100644 --- a/Foxnouns.Backend/Controllers/DebugController.cs +++ b/Foxnouns.Backend/Controllers/DebugController.cs @@ -14,13 +14,11 @@ public class DebugController( IClock clock, ILogger logger) : ApiControllerBase { - private readonly ILogger _logger = logger.ForContext(); - [HttpPost("users")] [ProducesResponseType(StatusCodes.Status200OK)] public async Task CreateUserAsync([FromBody] CreateUserRequest req) { - _logger.Debug("Creating user with username {Username} and email {Email}", req.Username, req.Email); + logger.Debug("Creating user with username {Username} and email {Email}", req.Username, req.Email); var user = await authSvc.CreateUserWithPasswordAsync(req.Username, req.Email, req.Password); var frontendApp = await db.GetFrontendApplicationAsync(); diff --git a/Foxnouns.Backend/Database/DatabaseQueryExtensions.cs b/Foxnouns.Backend/Database/DatabaseQueryExtensions.cs index 1d4e851..b8f10e9 100644 --- a/Foxnouns.Backend/Database/DatabaseQueryExtensions.cs +++ b/Foxnouns.Backend/Database/DatabaseQueryExtensions.cs @@ -49,8 +49,7 @@ public static class DatabaseQueryExtensions throw new ApiError.NotFound("No member with that ID found.", code: ErrorCode.MemberNotFound); } - public static async Task ResolveMemberAsync(this DatabaseContext context, string userRef, string memberRef, - Token? token) + public static async Task ResolveMemberAsync(this DatabaseContext context, string userRef, string memberRef, Token? token) { var user = await context.ResolveUserAsync(userRef, token); return await context.ResolveMemberAsync(user.Id, memberRef); diff --git a/Foxnouns.Backend/Database/Models/User.cs b/Foxnouns.Backend/Database/Models/User.cs index c152e65..305bd46 100644 --- a/Foxnouns.Backend/Database/Models/User.cs +++ b/Foxnouns.Backend/Database/Models/User.cs @@ -39,7 +39,7 @@ public class User : BaseModel public required string Tooltip { get; set; } public bool Muted { get; set; } public bool Favourite { get; set; } - + // This type is generally serialized directly, so the converter is applied here. [JsonConverter(typeof(ScreamingSnakeCaseEnumConverter))] public PreferenceSize Size { get; set; } diff --git a/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs b/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs index 1f1ee31..a76928c 100644 --- a/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs +++ b/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs @@ -5,7 +5,6 @@ using Foxnouns.Backend.Jobs; using Foxnouns.Backend.Middleware; using Foxnouns.Backend.Services; using Microsoft.EntityFrameworkCore; -using Minio; using NodaTime; using Prometheus; using Serilog; @@ -58,6 +57,16 @@ public static class WebApplicationExtensions return config; } + public static WebApplicationBuilder AddMetrics(this WebApplicationBuilder builder, Config config) + { + builder.Services.AddMetricServer(o => o.Port = config.Logging.MetricsPort) + .AddSingleton(); + if (!config.Logging.EnableMetrics) + builder.Services.AddHostedService(); + + return builder; + } + public static IConfigurationBuilder AddConfiguration(this IConfigurationBuilder builder) { var file = Environment.GetEnvironmentVariable("FOXNOUNS_CONFIG_FILE") ?? "config.ini"; @@ -69,40 +78,18 @@ public static class WebApplicationExtensions .AddEnvironmentVariables(); } - /// - /// Adds required services to the IServiceCollection. - /// This should only add services that are not ASP.NET-related (i.e. no middleware). - /// - public static IServiceCollection AddServices(this IServiceCollection services, Config config) - { - services - .AddQueue() - .AddDbContext() - .AddMetricServer(o => o.Port = config.Logging.MetricsPort) - .AddMinio(c => - c.WithEndpoint(config.Storage.Endpoint) - .WithCredentials(config.Storage.AccessKey, config.Storage.SecretKey) - .Build()) - .AddSingleton() - .AddSingleton(SystemClock.Instance) - .AddSnowflakeGenerator() - .AddScoped() - .AddScoped() - .AddScoped() - .AddScoped() - .AddScoped() - .AddScoped() - // Background services - .AddHostedService() - // Transient jobs - .AddTransient() - .AddTransient(); - - if (!config.Logging.EnableMetrics) - services.AddHostedService(); - - return services; - } + public static IServiceCollection AddCustomServices(this IServiceCollection services) => services + .AddSingleton(SystemClock.Instance) + .AddSnowflakeGenerator() + .AddScoped() + .AddScoped() + .AddScoped() + .AddScoped() + .AddScoped() + .AddScoped() + // Transient jobs + .AddTransient() + .AddTransient(); public static IServiceCollection AddCustomMiddleware(this IServiceCollection services) => services .AddScoped() diff --git a/Foxnouns.Backend/Foxnouns.Backend.csproj b/Foxnouns.Backend/Foxnouns.Backend.csproj index c22fdf4..82ccf80 100644 --- a/Foxnouns.Backend/Foxnouns.Backend.csproj +++ b/Foxnouns.Backend/Foxnouns.Backend.csproj @@ -6,31 +6,31 @@ - + - - - - + + + + runtime; build; native; contentfiles; analyzers; buildtransitive all - + - - - - - + + + + + - - - - + + + + diff --git a/Foxnouns.Backend/FoxnounsMetrics.cs b/Foxnouns.Backend/FoxnounsMetrics.cs index 648b97a..b5cc1ac 100644 --- a/Foxnouns.Backend/FoxnounsMetrics.cs +++ b/Foxnouns.Backend/FoxnounsMetrics.cs @@ -15,7 +15,7 @@ public static class FoxnounsMetrics public static readonly Gauge UsersActiveDayCount = Metrics.CreateGauge("foxnouns_user_count_active_day", "Number of users active in the last day"); - + public static readonly Gauge MemberCount = Metrics.CreateGauge("foxnouns_member_count", "Number of total members"); diff --git a/Foxnouns.Backend/GlobalUsing.cs b/Foxnouns.Backend/GlobalUsing.cs index 8c73595..5275c8d 100644 --- a/Foxnouns.Backend/GlobalUsing.cs +++ b/Foxnouns.Backend/GlobalUsing.cs @@ -1,2 +1,2 @@ global using ILogger = Serilog.ILogger; -global using Log = Serilog.Log; \ No newline at end of file +global using Log = Serilog.Log; diff --git a/Foxnouns.Backend/Jobs/UserAvatarUpdateInvocable.cs b/Foxnouns.Backend/Jobs/UserAvatarUpdateInvocable.cs index f0b04b2..cbec277 100644 --- a/Foxnouns.Backend/Jobs/UserAvatarUpdateInvocable.cs +++ b/Foxnouns.Backend/Jobs/UserAvatarUpdateInvocable.cs @@ -21,7 +21,7 @@ public class UserAvatarUpdateInvocable(DatabaseContext db, ObjectStorageService private async Task UpdateUserAvatarAsync(Snowflake id, string newAvatar) { _logger.Debug("Updating avatar for user {MemberId}", id); - + var user = await db.Users.FindAsync(id); if (user == null) { @@ -55,7 +55,7 @@ public class UserAvatarUpdateInvocable(DatabaseContext db, ObjectStorageService private async Task ClearUserAvatarAsync(Snowflake id) { _logger.Debug("Clearing avatar for user {MemberId}", id); - + var user = await db.Users.FindAsync(id); if (user == null) { diff --git a/Foxnouns.Backend/Middleware/ErrorHandlerMiddleware.cs b/Foxnouns.Backend/Middleware/ErrorHandlerMiddleware.cs index c52c3f0..39dfd85 100644 --- a/Foxnouns.Backend/Middleware/ErrorHandlerMiddleware.cs +++ b/Foxnouns.Backend/Middleware/ErrorHandlerMiddleware.cs @@ -110,7 +110,6 @@ public record HttpApiError [JsonConverter(typeof(ScreamingSnakeCaseEnumConverter))] public required ErrorCode Code { get; init; } - [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public string? ErrorId { get; init; } diff --git a/Foxnouns.Backend/Program.cs b/Foxnouns.Backend/Program.cs index 911c895..e849bd1 100644 --- a/Foxnouns.Backend/Program.cs +++ b/Foxnouns.Backend/Program.cs @@ -1,9 +1,12 @@ +using Coravel; using Foxnouns.Backend; +using Foxnouns.Backend.Database; using Serilog; using Foxnouns.Backend.Extensions; using Foxnouns.Backend.Services; using Foxnouns.Backend.Utils; using Microsoft.AspNetCore.Mvc; +using Minio; using Newtonsoft.Json; using Newtonsoft.Json.Serialization; using Prometheus; @@ -16,7 +19,9 @@ var builder = WebApplication.CreateBuilder(args); var config = builder.AddConfiguration(); -builder.AddSerilog(); +builder + .AddSerilog() + .AddMetrics(config); builder.WebHost .UseSentry(opts => @@ -59,10 +64,16 @@ JsonConvert.DefaultSettings = () => new JsonSerializerSettings }; builder.Services - .AddServices(config) + .AddQueue() + .AddDbContext() + .AddCustomServices() .AddCustomMiddleware() .AddEndpointsApiExplorer() - .AddSwaggerGen(); + .AddSwaggerGen() + .AddMinio(c => + c.WithEndpoint(config.Storage.Endpoint) + .WithCredentials(config.Storage.AccessKey, config.Storage.SecretKey) + .Build()); var app = builder.Build(); @@ -86,5 +97,23 @@ app.Urls.Add(config.Address); Metrics.DefaultRegistry.AddBeforeCollectCallback(async ct => await app.Services.GetRequiredService().CollectMetricsAsync(ct)); +// Fire off the periodic tasks loop in the background +_ = new Timer(_ => +{ + var __ = RunPeriodicTasksAsync(); +}, null, TimeSpan.FromSeconds(30), TimeSpan.FromMinutes(1)); + app.Run(); -Log.CloseAndFlush(); \ No newline at end of file +Log.CloseAndFlush(); + +return; + +async Task RunPeriodicTasksAsync() +{ + await using var scope = app.Services.CreateAsyncScope(); + var logger = scope.ServiceProvider.GetRequiredService(); + logger.Debug("Running periodic tasks"); + + var keyCacheSvc = scope.ServiceProvider.GetRequiredService(); + await keyCacheSvc.DeleteExpiredKeysAsync(); +} \ No newline at end of file diff --git a/Foxnouns.Backend/Services/KeyCacheService.cs b/Foxnouns.Backend/Services/KeyCacheService.cs index bd8a862..4523d16 100644 --- a/Foxnouns.Backend/Services/KeyCacheService.cs +++ b/Foxnouns.Backend/Services/KeyCacheService.cs @@ -9,8 +9,6 @@ namespace Foxnouns.Backend.Services; public class KeyCacheService(DatabaseContext db, IClock clock, ILogger logger) { - private readonly ILogger _logger = logger.ForContext(); - public Task SetKeyAsync(string key, string value, Duration expireAfter) => SetKeyAsync(key, value, clock.GetCurrentInstant() + expireAfter); @@ -39,10 +37,10 @@ public class KeyCacheService(DatabaseContext db, IClock clock, ILogger logger) return value.Value; } - public async Task DeleteExpiredKeysAsync(CancellationToken ct) + public async Task DeleteExpiredKeysAsync() { - var count = await db.TemporaryKeys.Where(k => k.Expires < clock.GetCurrentInstant()).ExecuteDeleteAsync(ct); - if (count != 0) _logger.Information("Removed {Count} expired keys from the database", count); + var count = await db.TemporaryKeys.Where(k => k.Expires < clock.GetCurrentInstant()).ExecuteDeleteAsync(); + if (count != 0) logger.Information("Removed {Count} expired keys from the database", count); } public Task SetKeyAsync(string key, T obj, Duration expiresAt) where T : class => diff --git a/Foxnouns.Backend/Services/ObjectStorageService.cs b/Foxnouns.Backend/Services/ObjectStorageService.cs index de60074..2180b90 100644 --- a/Foxnouns.Backend/Services/ObjectStorageService.cs +++ b/Foxnouns.Backend/Services/ObjectStorageService.cs @@ -7,25 +7,21 @@ namespace Foxnouns.Backend.Services; public class ObjectStorageService(ILogger logger, Config config, IMinioClient minio) { private readonly ILogger _logger = logger.ForContext(); - + public async Task RemoveObjectAsync(string path) { - _logger.Debug("Deleting object at path {Path}", path); + logger.Debug("Deleting object at path {Path}", path); try { await minio.RemoveObjectAsync(new RemoveObjectArgs().WithBucket(config.Storage.Bucket).WithObject(path)); } catch (InvalidObjectNameException) { - // ignore non-existent objects } } public async Task PutObjectAsync(string path, Stream data, string contentType) { - _logger.Debug("Putting object at path {Path} with length {Length} and content type {ContentType}", path, - data.Length, contentType); - await minio.PutObjectAsync(new PutObjectArgs() .WithBucket(config.Storage.Bucket) .WithObject(path) diff --git a/Foxnouns.Backend/Services/PeriodicTasksService.cs b/Foxnouns.Backend/Services/PeriodicTasksService.cs deleted file mode 100644 index b799abe..0000000 --- a/Foxnouns.Backend/Services/PeriodicTasksService.cs +++ /dev/null @@ -1,26 +0,0 @@ -namespace Foxnouns.Backend.Services; - -public class PeriodicTasksService(ILogger logger, IServiceProvider services) : BackgroundService -{ - private readonly ILogger _logger = logger.ForContext(); - - protected override async Task ExecuteAsync(CancellationToken ct) - { - using var timer = new PeriodicTimer(TimeSpan.FromMinutes(1)); - while (await timer.WaitForNextTickAsync(ct)) - { - _logger.Debug("Collecting metrics"); - await RunPeriodicTasksAsync(ct); - } - } - - private async Task RunPeriodicTasksAsync(CancellationToken ct) - { - _logger.Debug("Running periodic tasks"); - - await using var scope = services.CreateAsyncScope(); - - var keyCacheSvc = scope.ServiceProvider.GetRequiredService(); - await keyCacheSvc.DeleteExpiredKeysAsync(ct); - } -} \ No newline at end of file diff --git a/Foxnouns.Backend/Utils/ValidationUtils.cs b/Foxnouns.Backend/Utils/ValidationUtils.cs index 8100f4f..5c3c591 100644 --- a/Foxnouns.Backend/Utils/ValidationUtils.cs +++ b/Foxnouns.Backend/Utils/ValidationUtils.cs @@ -120,6 +120,7 @@ public static class ValidationUtils } + private static readonly string[] DefaultStatusOptions = [ "favourite", @@ -146,13 +147,11 @@ public static class ValidationUtils { case > Limits.FieldNameLimit: errors.Add(($"fields.{index}.name", - ValidationError.LengthError("Field name is too long", 1, Limits.FieldNameLimit, - field.Name.Length))); + ValidationError.LengthError("Field name is too long", 1, Limits.FieldNameLimit, field.Name.Length))); break; case < 1: errors.Add(($"fields.{index}.name", - ValidationError.LengthError("Field name is too short", 1, Limits.FieldNameLimit, - field.Name.Length))); + ValidationError.LengthError("Field name is too short", 1, Limits.FieldNameLimit, field.Name.Length))); break; }