Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Refactor TaskRunner and add logging test (#2159)

Leendert de Borst2d1e7a63fcef
diff --git a/apps/server/Services/AliasVault.TaskRunner/Program.cs b/apps/server/Services/AliasVault.TaskRunner/Program.cs
index 083db18d9..4313ec940 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Program.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Program.cs
@@ -29,14 +29,7 @@ builder.Services.AddMemoryCache();
builder.Services.AddSingleton<ServerSettingsService>();
// Define the tasks that will be executed by the TaskRunner.
-builder.Services.AddTransient<IMaintenanceTask, LogCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, RefreshTokenCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, EmailCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, EmailQuotaCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, DisabledEmailCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, OrphanedEmailCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, UnlockKeyHistoryCleanupTask>();
-builder.Services.AddTransient<IMaintenanceTask, VaultBlobCleanupTask>();
+builder.Services.AddMaintenanceTasks();
builder.Services.AddStatusHostedService<TaskRunnerWorker, AliasServerDbContext>(Assembly.GetExecutingAssembly().GetName().Name!);
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/DisabledEmailCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/DisabledEmailCleanupTask.cs
index 18c0cf207..e5a49f0f9 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/DisabledEmailCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/DisabledEmailCleanupTask.cs
@@ -45,7 +45,7 @@ public class DisabledEmailCleanupTask : IMaintenanceTask
var settings = await _settingsService.GetAllSettingsAsync();
if (settings.DisabledEmailRetentionDays <= 0)
{
- _logger.LogDebug("Disabled email cleanup is disabled (retention days set to 0)");
+ _logger.LogInformation("Disabled email cleanup is disabled (retention days set to 0), skipping.");
return;
}
@@ -57,9 +57,6 @@ public class DisabledEmailCleanupTask : IMaintenanceTask
.Where(e => e.DateSystem <= cutoffDate && dbContext.EmailClaims.Any(c => c.Address == e.To && !c.Links.Any(l => l.State != EmailClaimLinkState.Removed)))
.ExecuteDeleteAsync(cancellationToken);
- if (deletedCount > 0)
- {
- _logger.LogInformation("Deleted {Count} emails for aliases that no vault carries anymore.", deletedCount);
- }
+ _logger.LogInformation("Deleted {Count} emails for aliases that no vault carries anymore.", deletedCount);
}
}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailCleanupTask.cs
index 4ec13bb64..86b3e2d15 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailCleanupTask.cs
@@ -103,11 +103,6 @@ public class EmailCleanupTask : IMaintenanceTask
}
}
- if (totalEmailsDeleted > 0)
- {
- _logger.LogInformation(
- "Total emails deleted by age cleanup: {TotalEmails}",
- totalEmailsDeleted);
- }
+ _logger.LogInformation("Total emails deleted by age cleanup: {TotalEmails}", totalEmailsDeleted);
}
}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailQuotaCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailQuotaCleanupTask.cs
index 8bed95399..25094f5b0 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailQuotaCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/EmailQuotaCleanupTask.cs
@@ -129,12 +129,6 @@ public class EmailQuotaCleanupTask : IMaintenanceTask
}
}
- if (totalEmailsDeleted > 0)
- {
- _logger.LogInformation(
- "Total emails deleted by quota cleanup: {TotalEmails} across {UserCount} users",
- totalEmailsDeleted,
- usersProcessed);
- }
+ _logger.LogInformation("Total emails deleted by quota cleanup: {TotalEmails} across {UserCount} users", totalEmailsDeleted, usersProcessed);
}
}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/MaintenanceTaskRegistration.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/MaintenanceTaskRegistration.cs
new file mode 100644
index 000000000..d61133ba7
--- /dev/null
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/MaintenanceTaskRegistration.cs
@@ -0,0 +1,33 @@
+//-----------------------------------------------------------------------
+// <copyright file="MaintenanceTaskRegistration.cs" company="aliasvault">
+// Copyright (c) aliasvault. All rights reserved.
+// Licensed under the AGPLv3 license. See LICENSE.md file in the project root for full license information.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace AliasVault.TaskRunner.Tasks;
+
+/// <summary>
+/// Registers the maintenance tasks the TaskRunner executes, in execution order.
+/// </summary>
+public static class MaintenanceTaskRegistration
+{
+ /// <summary>
+ /// Adds all maintenance tasks to the service collection.
+ /// </summary>
+ /// <param name="services">The service collection.</param>
+ /// <returns>The same instance, for chaining.</returns>
+ public static IServiceCollection AddMaintenanceTasks(this IServiceCollection services)
+ {
+ services.AddTransient<IMaintenanceTask, LogCleanupTask>();
+ services.AddTransient<IMaintenanceTask, RefreshTokenCleanupTask>();
+ services.AddTransient<IMaintenanceTask, EmailCleanupTask>();
+ services.AddTransient<IMaintenanceTask, EmailQuotaCleanupTask>();
+ services.AddTransient<IMaintenanceTask, DisabledEmailCleanupTask>();
+ services.AddTransient<IMaintenanceTask, OrphanedEmailCleanupTask>();
+ services.AddTransient<IMaintenanceTask, UnlockKeyHistoryCleanupTask>();
+ services.AddTransient<IMaintenanceTask, VaultBlobCleanupTask>();
+
+ return services;
+ }
+}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/OrphanedEmailCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/OrphanedEmailCleanupTask.cs
index 4c7c21dea..1e675879a 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/OrphanedEmailCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/OrphanedEmailCleanupTask.cs
@@ -46,9 +46,6 @@ public class OrphanedEmailCleanupTask : IMaintenanceTask
.Where(x => !x.DecryptionKeys.Any())
.ExecuteDeleteAsync(cancellationToken);
- if (deletedCount > 0)
- {
- _logger.LogInformation("Deleted {Count} emails that no remaining key can decrypt.", deletedCount);
- }
+ _logger.LogInformation("Deleted {Count} emails that no remaining key can decrypt.", deletedCount);
}
}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/RefreshTokenCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/RefreshTokenCleanupTask.cs
index d46aad4c1..fb042b387 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/RefreshTokenCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/RefreshTokenCleanupTask.cs
@@ -44,9 +44,6 @@ public class RefreshTokenCleanupTask : IMaintenanceTask
.Where(x => x.ExpireDate < cutoffDate)
.ExecuteDeleteAsync(cancellationToken);
- if (deletedCount > 0)
- {
- _logger.LogInformation("Deleted {Count} expired refresh tokens", deletedCount);
- }
+ _logger.LogInformation("Deleted {Count} expired refresh tokens", deletedCount);
}
}
diff --git a/apps/server/Services/AliasVault.TaskRunner/Tasks/UnlockKeyHistoryCleanupTask.cs b/apps/server/Services/AliasVault.TaskRunner/Tasks/UnlockKeyHistoryCleanupTask.cs
index cc8e29052..a27bde26a 100644
--- a/apps/server/Services/AliasVault.TaskRunner/Tasks/UnlockKeyHistoryCleanupTask.cs
+++ b/apps/server/Services/AliasVault.TaskRunner/Tasks/UnlockKeyHistoryCleanupTask.cs
@@ -51,9 +51,6 @@ public class UnlockKeyHistoryCleanupTask : IMaintenanceTask
var deletedCount = await UnlockKeyHistoryPolicy.DeleteExpiredAsync(dbContext.UserUnlockKeysHistory, settings.UnlockKeyHistoryRetentionDays, DateTime.UtcNow, cancellationToken);
- if (deletedCount > 0)
- {
- _logger.LogInformation("Deleted {Count} archived unlock keys older than {Days} days", deletedCount, UnlockKeyHistoryPolicy.EffectiveRetentionDays(settings.UnlockKeyHistoryRetentionDays));
- }
+ _logger.LogInformation("Deleted {Count} archived unlock keys older than {Days} days", deletedCount, UnlockKeyHistoryPolicy.EffectiveRetentionDays(settings.UnlockKeyHistoryRetentionDays));
}
}
diff --git a/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/Helpers/TestHostBuilder.cs b/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/Helpers/TestHostBuilder.cs
index 7429f8782..3f3ea5038 100644
--- a/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/Helpers/TestHostBuilder.cs
+++ b/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/Helpers/TestHostBuilder.cs
@@ -30,22 +30,19 @@ public class TestHostBuilder : AbstractTestHostBuilder
// Add specific services for the TestExceptionWorker.
builder.ConfigureServices((context, services) =>
{
- // Add server settings service
services.AddMemoryCache();
services.AddSingleton<ServerSettingsService>();
-
- // Add maintenance tasks
- services.AddTransient<IMaintenanceTask, LogCleanupTask>();
- services.AddTransient<IMaintenanceTask, EmailCleanupTask>();
- services.AddTransient<IMaintenanceTask, EmailQuotaCleanupTask>();
- services.AddTransient<IMaintenanceTask, DisabledEmailCleanupTask>();
- services.AddTransient<IMaintenanceTask, UnlockKeyHistoryCleanupTask>();
- services.AddTransient<IMaintenanceTask, VaultBlobCleanupTask>();
-
- // Add the TaskRunner worker
+ services.AddMaintenanceTasks();
services.AddHostedService<TaskRunnerWorker>();
});
return builder.Build();
}
+
+ /// <inheritdoc />
+ protected override void AddIntegrationTestConfiguration(IDictionary<string, string?> settings)
+ {
+ // Match the log level of the TaskRunner service itself, the shared test appsettings.json defaults to Warning.
+ settings["Logging:LogLevel:AliasVault.TaskRunner"] = "Information";
+ }
}
diff --git a/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/TaskRunnerTests.cs b/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/TaskRunnerTests.cs
index c2468a2f0..64ca2c67d 100644
--- a/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/TaskRunnerTests.cs
+++ b/apps/server/Tests/AliasVault.IntegrationTests/TaskRunner/TaskRunnerTests.cs
@@ -10,7 +10,9 @@ namespace AliasVault.IntegrationTests.TaskRunner;
using AliasServerDb;
using AliasVault.IntegrationTests.TaskRunner.Helpers;
using AliasVault.Shared.Models.Enums;
+using AliasVault.TaskRunner.Tasks;
using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
/// <summary>
@@ -51,6 +53,39 @@ public class TaskRunnerTests
await _testHostBuilder.DisposeAsync();
}
+ /// <summary>
+ /// Tests that every maintenance task in the TaskRunner assembly is registered and leaves at least one entry in
+ /// the general logs after a run with default settings. A new task fails here until it is registered, logs a
+ /// summary on every run and is allowed to log to the database (see LoggingConfiguration). A task that should
+ /// stay silent on purpose can be added to the exclusion list below.
+ /// </summary>
+ /// <returns>Task.</returns>
+ [Test]
+ public async Task EveryMaintenanceTaskWritesGeneralLog()
+ {
+ // Tasks that are deliberately allowed to run without leaving a general log entry.
+ // Currently none by design, hence empty list.
+ var silentTasks = new HashSet<Type>();
+
+ var taskTypes = typeof(IMaintenanceTask).Assembly.GetTypes()
+ .Where(t => typeof(IMaintenanceTask).IsAssignableFrom(t) && t is { IsClass: true, IsAbstract: false })
+ .ToList();
+ Assert.That(taskTypes, Is.Not.Empty, "No maintenance tasks were discovered.");
+
+ var registeredTypes = _testHost.Services.GetServices<IMaintenanceTask>().Select(t => t.GetType()).ToList();
+ Assert.That(registeredTypes, Is.EquivalentTo(taskTypes), "Every maintenance task must be registered exactly once in MaintenanceTaskRegistration.");
+
+ // Run against an empty database so all server settings are at their defaults.
+ await _testHost.StartAsync();
+ await WaitForMaintenanceJobCompletion();
+
+ await using var dbContext = await _testHostBuilder.GetDbContextAsync();
+ var loggedSources = await dbContext.Logs.Select(x => x.SourceContext).Distinct().ToListAsync();
+ var tasksWithoutLog = taskTypes.Where(t => !silentTasks.Contains(t) && !loggedSources.Contains(t.FullName!)).Select(t => t.Name).ToList();
+
+ Assert.That(tasksWithoutLog, Is.Empty, "These maintenance tasks left no general log entry after a run with default settings. Sources seen: " + string.Join(", ", loggedSources));
+ }
+
/// <summary>
/// Tests the EmailCleanup task.
/// </summary>