Refactor: split up repositories and services

Author: Rens van Moorsel

Backend/Controllers/Mails.cs

@@ -1,5 +1,6 @@
 using Backend.Controllers.DTOs;
 using Backend.Interfaces;
+using Backend.Services.MailServices;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 

Backend/Docs/Migrations.md

@@ -1,5 +1,12 @@
 using Backend.Database;
+using Backend.Repositories;
 using Backend.Services;
+using Backend.Services.AccountingToolServices;
+using Backend.Services.AuthServices;
+using Backend.Services.FileCompressServices;
+using Backend.Services.MailServices;
+using Backend.Services.MailSubscriptionServices;
+using Backend.Services.StorageServices;
 using DotNetEnv;
 using Mollie.Api;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
@@ -235,7 +242,7 @@
 
 builder.Services.AddScoped<IStorageService, S3StorageService>();
 builder.Services.AddScoped<IFileCompressService, FileCompressService>();
-builder.Services.AddScoped<IPaymentValidationService, PaymentValidationService>();
+builder.Services.AddScoped<IPaymentValidationService, PaymentValidationRepository>();
 builder.Services.AddScoped<IPermissionService, PermissionService>();
 
 string? mailProvider = Environment.GetEnvironmentVariable("MAIL_SERVICE");
@@ -283,23 +290,23 @@
         break;
 }
 
-builder.Services.AddScoped<IActivityService, ActivityService>();
-builder.Services.AddScoped<IAnnouncementService, AnnouncementService>();
-builder.Services.AddScoped<IEnrollmentService, EnrollmentService>();
-builder.Services.AddScoped<IGroupMembershipService, GroupMembershipService>();
-builder.Services.AddScoped<IGroupService, GroupService>();
-builder.Services.AddScoped<IMemberService, MemberService>();
-builder.Services.AddScoped<IPaymentService, PaymentService>();
+builder.Services.AddScoped<IActivityService, ActivityRepository>();
+builder.Services.AddScoped<IAnnouncementService, AnnouncementRepository>();
+builder.Services.AddScoped<IEnrollmentService, EnrollmentRepository>();
+builder.Services.AddScoped<IGroupMembershipService, GroupMembershipRepository>();
+builder.Services.AddScoped<IGroupService, GroupRepository>();
+builder.Services.AddScoped<IMemberService, MemberRepository>();
+builder.Services.AddScoped<IPaymentService, PaymentRepository>();
 builder.Services.AddScoped<IPaymentWebhookService, PaymentWebhookService>();
 builder.Services.AddScoped<IPermissionService, PermissionService>();
-builder.Services.AddScoped<IProfilePictureService, ProfilePictureService>();
-builder.Services.AddScoped<IRoleAliasService, RoleAliasService>();
-builder.Services.AddScoped<IRoleService, RoleService>();
-builder.Services.AddScoped<IStudyEnrollmentService, StudyEnrollmentService>();
-builder.Services.AddScoped<IStudyService, StudyService>();
-builder.Services.AddScoped<ISpecificationAnswerService, SpecificationAnswerService>();
-builder.Services.AddScoped<ISettingsService, SettingsService>();
-builder.Services.AddScoped<IMailinglistService, MailinglistService>();
+builder.Services.AddScoped<IProfilePictureService, ProfilePictureRepository>();
+builder.Services.AddScoped<IRoleAliasService, RoleAliasRepository>();
+builder.Services.AddScoped<IRoleService, RoleRepository>();
+builder.Services.AddScoped<IStudyEnrollmentService, StudyEnrollmentRepository>();
+builder.Services.AddScoped<IStudyService, StudyRepository>();
+builder.Services.AddScoped<ISpecificationAnswerService, SpecificationAnswerRepository>();
+builder.Services.AddScoped<ISettingsService, SettingsRepository>();
+builder.Services.AddScoped<IMailinglistService, MailinglistRepository>();
 
 builder.Services.AddScoped<ICreateNewBoardService, CreateNewBoardService>();
 builder.Services.AddHostedService<DatabaseSeeder>();

Backend/Program.cs

@@ -5,31 +5,32 @@
 using Backend.Projections;
 using Backend.Validators;
 using Backend.QueryExtensions;
+using Backend.Services.MailServices;
 using Microsoft.AspNetCore.JsonPatch;
 using Microsoft.EntityFrameworkCore;
 using System.Text;
 using Backend.Utils.DateTime;
 
-namespace Backend.Services;
+namespace Backend.Repositories;
 
 /// <summary>
 /// Implements activity management, poster handling, and enrollment exports.
 /// </summary>
-public class ActivityService : IActivityService
+public class ActivityRepository : IActivityService
 {
     private readonly PostgresDbContext _db;
     private readonly IStorageService _storageService;
     private readonly IFileCompressService _fileCompressor;
     private readonly IPermissionService _permissionService;
     private readonly IEnrollmentService _enrollmentService;
     private readonly AbstractMailService _mailService;
-    private readonly ILogger<ActivityService> _logger;
+    private readonly ILogger<ActivityRepository> _logger;
 
     private readonly string[] _restrictedForEveryonePaths = new [] {"/id", "/posterFileName", "/posterPath", };
     private readonly string[] _restrictedPaths = new[] { "/vatRate", "/gLAccountId", "/costCenterId", "/costUnitId", "/paymentDeadline", "/showInKoala", "/enrollOpenDate", "/showOnWebsite", "/paymentDeadline", "/enrollOpenDate" };
 
     /// <summary>
-    /// Initializes a new instance of the ActivityService class with the specified database context, storage service, file compressor, permission service, enrollment service, mail service, and logger. The constructor sets up the necessary dependencies for managing activities, including database access for activity data, storage service for handling activity posters, file compressor for optimizing poster files, permission service for enforcing access control on activity operations, enrollment service for managing enrollments related to activities, mail service for sending notifications about activity-related events, and logging for monitoring activity management operations and troubleshooting any issues that may arise.
+    /// Initializes a new instance of the ActivityRepository class with the specified database context, storage service, file compressor, permission service, enrollment service, mail service, and logger. The constructor sets up the necessary dependencies for managing activities, including database access for activity data, storage service for handling activity posters, file compressor for optimizing poster files, permission service for enforcing access control on activity operations, enrollment service for managing enrollments related to activities, mail service for sending notifications about activity-related events, and logging for monitoring activity management operations and troubleshooting any issues that may arise.
     /// </summary>
     /// <param name="db">The database context.</param>
     /// <param name="storageService">The storage service.</param>
@@ -38,14 +39,14 @@ public class ActivityService : IActivityService
     /// <param name="enrollmentService">The enrollment service.</param>
     /// <param name="mailService">The mail service.</param>
     /// <param name="logger">The logger.</param>
-    public ActivityService(
+    public ActivityRepository(
         PostgresDbContext db,
         IStorageService storageService,
         IFileCompressService fileCompressor,
         IPermissionService permissionService,
         IEnrollmentService enrollmentService,
         AbstractMailService mailService,
-        ILogger<ActivityService> logger)
+        ILogger<ActivityRepository> logger)
     {
         _db = db;
         _storageService = storageService;

Backend/Services/ActivityService.cs …ckend/Repositories/ActivityRepository.csBackend/Services/ActivityService.cs renamed to Backend/Repositories/ActivityRepository.cs Backend/Services/ActivityService.cs renamed to Backend/Repositories/ActivityRepository.cs

@@ -7,24 +7,24 @@
 using Microsoft.AspNetCore.JsonPatch;
 using Microsoft.EntityFrameworkCore;
 
-namespace Backend.Services;
+namespace Backend.Repositories;
 
 /// <summary>
 /// Implements announcement management operations.
 /// </summary>
-public class AnnouncementService : IAnnouncementService
+public class AnnouncementRepository : IAnnouncementService
 {
     private readonly PostgresDbContext _db;
     private readonly IPermissionService _permissionService;
-    private readonly ILogger<AnnouncementService> _logger;
+    private readonly ILogger<AnnouncementRepository> _logger;
 
     /// <summary>
-    /// Initializes a new instance of the AnnouncementService class with the specified database context, permission service, and logger. The constructor sets up the necessary dependencies for managing announcements, allowing the service to interact with the database for CRUD operations on announcements, perform permission checks to ensure that only authorized users can create, update, or delete announcements, and log important events and errors that occur during announcement management for monitoring and debugging purposes.
+    /// Initializes a new instance of the AnnouncementRepository class with the specified database context, permission service, and logger. The constructor sets up the necessary dependencies for managing announcements, allowing the service to interact with the database for CRUD operations on announcements, perform permission checks to ensure that only authorized users can create, update, or delete announcements, and log important events and errors that occur during announcement management for monitoring and debugging purposes.
     /// </summary>
     /// <param name="db">The database context.</param>
     /// <param name="permissionService">The permission service.</param>
     /// <param name="logger">The logger.</param>
-    public AnnouncementService(PostgresDbContext db, IPermissionService permissionService, ILogger<AnnouncementService> logger)
+    public AnnouncementRepository(PostgresDbContext db, IPermissionService permissionService, ILogger<AnnouncementRepository> logger)
     {
         _db = db;
         _permissionService = permissionService;

Backend/Services/AnnouncementService.cs …d/Repositories/AnnouncementRepository.csBackend/Services/AnnouncementService.cs renamed to Backend/Repositories/AnnouncementRepository.cs Backend/Services/AnnouncementService.cs renamed to Backend/Repositories/AnnouncementRepository.cs

@@ -6,36 +6,37 @@
 using Backend.Projections;
 using Backend.Validators;
 using Backend.QueryExtensions;
+using Backend.Services.MailServices;
 using Microsoft.AspNetCore.JsonPatch;
 using Microsoft.EntityFrameworkCore;
 
-namespace Backend.Services;
+namespace Backend.Repositories;
 
 /// <summary>
 /// Implements enrollment workflows, including waiting-list promotion.
 /// </summary>
-public class EnrollmentService : IEnrollmentService
+public class EnrollmentRepository : IEnrollmentService
 {
     private readonly PostgresDbContext _db;
     private readonly IPermissionService _permissionService;
     private readonly IPaymentValidationService _paymentValidationService;
     private readonly AbstractMailService _mailService;
-    private readonly ILogger<EnrollmentService> _logger;
+    private readonly ILogger<EnrollmentRepository> _logger;
 
     /// <summary>
-    /// Initializes a new instance of the EnrollmentService class with the specified database context, permission service, payment validation service, mail service, and logger. The constructor sets up the necessary dependencies for managing enrollments, allowing the service to interact with the database for enrollment operations, perform permission checks to ensure that only authorized users can manage enrollments, validate payments when necessary, send emails related to enrollment actions, and log important events and errors that occur during enrollment management for monitoring and debugging purposes.
+    /// Initializes a new instance of the EnrollmentRepository class with the specified database context, permission service, payment validation service, mail service, and logger. The constructor sets up the necessary dependencies for managing enrollments, allowing the service to interact with the database for enrollment operations, perform permission checks to ensure that only authorized users can manage enrollments, validate payments when necessary, send emails related to enrollment actions, and log important events and errors that occur during enrollment management for monitoring and debugging purposes.
     /// </summary>
     /// <param name="db">The database context.</param>
     /// <param name="permissionService">The permission service.</param>
     /// <param name="paymentValidationService">The payment validation service.</param>
     /// <param name="mailService">The mail service.</param>
     /// <param name="logger">The logger.</param>
-    public EnrollmentService(
+    public EnrollmentRepository(
         PostgresDbContext db,
         IPermissionService permissionService,
         IPaymentValidationService paymentValidationService,
         AbstractMailService mailService,
-        ILogger<EnrollmentService> logger)
+        ILogger<EnrollmentRepository> logger)
     {
         _db = db;
         _permissionService = permissionService;

Backend/Services/EnrollmentService.cs …end/Repositories/EnrollmentRepository.csBackend/Services/EnrollmentService.cs renamed to Backend/Repositories/EnrollmentRepository.cs Backend/Services/EnrollmentService.cs renamed to Backend/Repositories/EnrollmentRepository.cs

@@ -4,29 +4,30 @@
 using Backend.Models.Domain;
 using Backend.Validators;
 using Backend.Projections;
+using Backend.Services;
 using Microsoft.AspNetCore.JsonPatch;
 using Microsoft.EntityFrameworkCore;
 
-namespace Backend.Services;
+namespace Backend.Repositories;
 
 /// <summary>
 /// Implements group-membership management operations.
 /// </summary>
-public class GroupMembershipService : IGroupMembershipService
+public class GroupMembershipRepository : IGroupMembershipService
 {
     private readonly PostgresDbContext _db;
     private readonly IPermissionService _permissionService;
     private readonly AuthOutboxWorker _authOutboxWorker;
-    private readonly ILogger<GroupMembershipService> _logger;
+    private readonly ILogger<GroupMembershipRepository> _logger;
 
     /// <summary>
-    /// Initializes a new instance of the GroupMembershipService class with the specified dependencies. The constructor sets up the necessary services for managing group memberships, including database access, permission checks, integration with the authentication outbox worker for synchronizing membership changes with the configured auth system, and logging for monitoring group membership operations. This setup allows the GroupMembershipService to effectively handle creating, retrieving, updating, and deleting group memberships while ensuring that only authorized users can perform these actions and that any significant events are logged for auditing and debugging purposes.
+    /// Initializes a new instance of the GroupMembershipRepository class with the specified dependencies. The constructor sets up the necessary services for managing group memberships, including database access, permission checks, integration with the authentication outbox worker for synchronizing membership changes with the configured auth system, and logging for monitoring group membership operations. This setup allows the GroupMembershipRepository to effectively handle creating, retrieving, updating, and deleting group memberships while ensuring that only authorized users can perform these actions and that any significant events are logged for auditing and debugging purposes.
     /// </summary>
     /// <param name="db">The database context.</param>
     /// <param name="permissionService">The permission service.</param>
     /// <param name="authOutboxWorker">The authentication outbox worker.</param>
     /// <param name="logger">The logger.</param>
-    public GroupMembershipService(PostgresDbContext db, IPermissionService permissionService, AuthOutboxWorker authOutboxWorker, ILogger<GroupMembershipService> logger)
+    public GroupMembershipRepository(PostgresDbContext db, IPermissionService permissionService, AuthOutboxWorker authOutboxWorker, ILogger<GroupMembershipRepository> logger)
     {
         _db = db;
         _permissionService = permissionService;