Integration von RemoveIfControllerConvention zur bedingten Ausschließung von Test-Controllern

Implementierung von RemoveIfControllerConvention in der Startup-Klasse, um Controller, die mit "Test" beginnen, basierend auf einem Konfigurationsflag auszuschließen, was die Flexibilität der Dienstregistrierung erhöht.

EnvelopeGenerator.Application/DTOs/DocumentReceiverElementDto.cs

@@ -16,8 +16,7 @@
         int AnnotationIndex,
         DateTime AddedWhen,
         DateTime? ChangedWhen,
-        EnvelopeDocumentDto? Document,
-        EnvelopeReceiverDto? Receiver,
         double Top,
-        double Left);
+        double Left
+        );
 }

EnvelopeGenerator.Application/DTOs/EnvelopeDocumentDto.cs

@@ -1,6 +1,4 @@
-using EnvelopeGenerator.Domain.Entities;
+namespace EnvelopeGenerator.Application.DTOs
-
-namespace EnvelopeGenerator.Application.DTOs
 {
     public record EnvelopeDocumentDto
     (
@@ -10,6 +8,6 @@ namespace EnvelopeGenerator.Application.DTOs
         string Filepath,
         DateTime AddedWhen,
         string FilenameOriginal,
-        IEnumerable<DocumentReceiverElement>? Elements
+        IEnumerable<DocumentReceiverElementDto>? Elements
     );
 }

EnvelopeGenerator.Application/DTOs/ReceiverDto.cs

@@ -4,5 +4,6 @@
         int Id,
         string EmailAddress,
         string Signature,
-        DateTime AddedWhen);
+        DateTime AddedWhen,
+        IEnumerable<EnvelopeReceiverDto>? EnvelopeReceivers);
 }

EnvelopeGenerator.Domain/Entities/DocumentReceiverElement.cs

@@ -28,12 +28,12 @@ namespace EnvelopeGenerator.Domain.Entities
         [Required]
         [Column("POSITION_X")]
         [DefaultValue(0)]
-        public double X { get; set; }
+        public double PositionX { get; set; }
 
         [Required]
         [Column("POSITION_Y")]
         [DefaultValue(0)]
-        public double Y { get; set; }
+        public double PositionY { get; set; }
 
         [Required]
         [Column("WIDTH")]
@@ -83,9 +83,9 @@ namespace EnvelopeGenerator.Domain.Entities
         public virtual Receiver? Receiver { get; set; }
 
         [NotMapped]
-        public double Top => Math.Round(Y, 5);
+        public double Top => Math.Round(PositionY, 5);
 
         [NotMapped]
-        public double Left => Math.Round(X, 5);
+        public double Left => Math.Round(PositionX, 5);
     }
 }

EnvelopeGenerator.Infrastructure/Repositories/EnvelopeRepository.cs

@@ -39,7 +39,7 @@ namespace EnvelopeGenerator.Infrastructure.Repositories
                 query = query.Where(e => e.Receivers != null && e.Receivers.Any(er => er.Receiver != null && er.Receiver.Signature == signature));
 
             if (withAll || withDocuments)
-                if (withDocumentReceiverElement)
+                if (withAll || withDocumentReceiverElement)
                     query = query.Include(e => e.Documents!).ThenInclude(d => d.Elements);
                 else
                     query = query.Include(e => e.Documents);

EnvelopeGenerator.Web/Controllers/Test/TestConfigController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestConfigController : BasicCRUDControllerBase<TestConfigController, IConfigService, IConfigRepository, ConfigDto, Config, int>
+    public class TestConfigController : TestControllerBase<TestConfigController, IConfigService, IConfigRepository, ConfigDto, Config, int>
     {
         public TestConfigController(ILogger<TestConfigController> logger, IConfigService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestControllerBase.cs

@@ -0,0 +1,21 @@
+using DigitalData.Core.API;
+using DigitalData.Core.Contracts.Application;
+using DigitalData.Core.Contracts.Infrastructure;
+using EnvelopeGenerator.Application.Contracts;
+using EnvelopeGenerator.Application.DTOs;
+using EnvelopeGenerator.Infrastructure.Contracts;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+
+namespace EnvelopeGenerator.Web.Controllers.Test
+{
+    //[NonController]
+    [ApiController]
+    [Route("api/test/[controller]")]
+    public class TestControllerBase<TOriginalController, TCRUDService, TCRUDRepository, TDto, TEntity, TId> : BasicCRUDControllerBase<TOriginalController, TCRUDService, TCRUDRepository, TDto, TEntity, TId> where TOriginalController : CRUDControllerBase<TOriginalController, TCRUDService, TCRUDRepository, TDto, TDto, TDto, TEntity, TId> where TCRUDService : ICRUDService<TCRUDRepository, TDto, TDto, TDto, TEntity, TId> where TCRUDRepository : ICRUDRepository<TEntity, TId> where TDto : class where TEntity : class
+    {
+        public TestControllerBase(ILogger<TOriginalController> logger, TCRUDService service) : base(logger, service)
+        {
+        }
+    }
+}

EnvelopeGenerator.Web/Controllers/Test/TestDocumentReceiverElementController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestDocumentReceiverElementController : BasicCRUDControllerBase<TestDocumentReceiverElementController, IDocumentReceiverElementService, IDocumentReceiverElementRepository, DocumentReceiverElementDto, DocumentReceiverElement, int>
+    public class TestDocumentReceiverElementController : TestControllerBase<TestDocumentReceiverElementController, IDocumentReceiverElementService, IDocumentReceiverElementRepository, DocumentReceiverElementDto, DocumentReceiverElement, int>
     {
         public TestDocumentReceiverElementController(ILogger<TestDocumentReceiverElementController> logger, IDocumentReceiverElementService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestDocumentStatusController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestDocumentStatusController : BasicCRUDControllerBase<TestDocumentStatusController, IDocumentStatusService, IDocumentStatusRepository, DocumentStatusDto, DocumentStatus, int>
+    public class TestDocumentStatusController : TestControllerBase<TestDocumentStatusController, IDocumentStatusService, IDocumentStatusRepository, DocumentStatusDto, DocumentStatus, int>
     {
         public TestDocumentStatusController(ILogger<TestDocumentStatusController> logger, IDocumentStatusService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEmailTemplateController.cs

@@ -1,12 +1,11 @@
-using DigitalData.Core.API;
+using EnvelopeGenerator.Application.Contracts;
-using EnvelopeGenerator.Application.Contracts;
 using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEmailTemplateController : CRUDControllerBase<TestEmailTemplateController, IEmailTemplateService, IEmailTemplateRepository, EmailTemplateDto, EmailTemplateDto, EmailTemplateDto, EmailTemplate, int>
+    public class TestEmailTemplateController : TestControllerBase<TestEmailTemplateController, IEmailTemplateService, IEmailTemplateRepository, EmailTemplateDto, EmailTemplate, int>
     {
         public TestEmailTemplateController(ILogger<TestEmailTemplateController> logger, IEmailTemplateService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeCertificateController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeCertificateController : BasicCRUDControllerBase<TestEnvelopeCertificateController, IEnvelopeCertificateService, IEnvelopeCertificateRepository, EnvelopeCertificateDto, EnvelopeCertificate, int>
+    public class TestEnvelopeCertificateController : TestControllerBase<TestEnvelopeCertificateController, IEnvelopeCertificateService, IEnvelopeCertificateRepository, EnvelopeCertificateDto, EnvelopeCertificate, int>
     {
         public TestEnvelopeCertificateController(ILogger<TestEnvelopeCertificateController> logger, IEnvelopeCertificateService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeController.cs

@@ -1,14 +1,13 @@
-using DigitalData.Core.API;
+using EnvelopeGenerator.Application.Contracts;
-using EnvelopeGenerator.Application.Contracts;
 using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Application.Services;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 using Microsoft.AspNetCore.Mvc;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeController : CRUDControllerBase<TestEnvelopeController, IEnvelopeService, IEnvelopeRepository, EnvelopeDto, EnvelopeDto, EnvelopeDto, Envelope, int>
+    public class TestEnvelopeController : TestControllerBase<TestEnvelopeController, IEnvelopeService, IEnvelopeRepository, EnvelopeDto, Envelope, int>
     {
         public TestEnvelopeController(ILogger<TestEnvelopeController> logger, IEnvelopeService service) : base(logger, service)
         {
@@ -21,7 +20,7 @@ namespace EnvelopeGenerator.Web.Controllers
         }
 
         [HttpGet]
-        public virtual async Task<IActionResult> GetAll([FromQuery] string? envelopeKey = default, [FromQuery] bool withDocuments = true, [FromQuery] bool withReceivers = true, [FromQuery] bool withHistory = true)
+        public virtual async Task<IActionResult> GetAll([FromQuery] string? envelopeKey = default, [FromQuery] bool withDocuments = false, [FromQuery] bool withReceivers = false, [FromQuery] bool withHistory = false, [FromQuery] bool withDocumentReceiverElement = false, [FromQuery] bool withAll = true)
         {
             if(envelopeKey is not null)
             {
@@ -30,7 +29,7 @@ namespace EnvelopeGenerator.Web.Controllers
                 var envlopeServiceResult = await _service.ReadByUuidAsync(
                     uuid: decoded.EnvelopeUuid,
                     signature: decoded.ReceiverSignature,
-                    withDocuments: withDocuments, withReceivers: withReceivers, withHistory: withHistory);
+                    withDocuments: withDocuments, withReceivers: withReceivers, withHistory: withHistory, withDocumentReceiverElement:withDocumentReceiverElement, withAll:withAll);
 
                 if (envlopeServiceResult.IsSuccess)
                 {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeDocumentController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeDocumentController : BasicCRUDControllerBase<TestEnvelopeDocumentController, IEnvelopeDocumentService, IEnvelopeDocumentRepository, EnvelopeDocumentDto, EnvelopeDocument, int>
+    public class TestEnvelopeDocumentController : TestControllerBase<TestEnvelopeDocumentController, IEnvelopeDocumentService, IEnvelopeDocumentRepository, EnvelopeDocumentDto, EnvelopeDocument, int>
     {
         public TestEnvelopeDocumentController(ILogger<TestEnvelopeDocumentController> logger, IEnvelopeDocumentService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeHistoryController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeHistoryController : BasicCRUDControllerBase<TestEnvelopeHistoryController, IEnvelopeHistoryService, IEnvelopeHistoryRepository, EnvelopeHistoryDto, EnvelopeHistory, long>
+    public class TestEnvelopeHistoryController : TestControllerBase<TestEnvelopeHistoryController, IEnvelopeHistoryService, IEnvelopeHistoryRepository, EnvelopeHistoryDto, EnvelopeHistory, long>
     {
         public TestEnvelopeHistoryController(ILogger<TestEnvelopeHistoryController> logger, IEnvelopeHistoryService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeReceiverController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeReceiverController : BasicCRUDControllerBase<TestEnvelopeReceiverController, IEnvelopeReceiverService, IEnvelopeReceiverRepository, EnvelopeReceiverDto, EnvelopeReceiver, int>
+    public class TestEnvelopeReceiverController : TestControllerBase<TestEnvelopeReceiverController, IEnvelopeReceiverService, IEnvelopeReceiverRepository, EnvelopeReceiverDto, EnvelopeReceiver, int>
     {
         public TestEnvelopeReceiverController(ILogger<TestEnvelopeReceiverController> logger, IEnvelopeReceiverService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestEnvelopeTypeController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestEnvelopeTypeController : BasicCRUDControllerBase<TestEnvelopeTypeController, IEnvelopeTypeService, IEnvelopeTypeRepository, EnvelopeTypeDto, EnvelopeType, int>
+    public class TestEnvelopeTypeController : TestControllerBase<TestEnvelopeTypeController, IEnvelopeTypeService, IEnvelopeTypeRepository, EnvelopeTypeDto, EnvelopeType, int>
     {
         public TestEnvelopeTypeController(ILogger<TestEnvelopeTypeController> logger, IEnvelopeTypeService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestReceiverController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestReceiverController : BasicCRUDControllerBase<TestReceiverController, IReceiverService, IReceiverRepository, ReceiverDto, Receiver, int>
+    public class TestReceiverController : TestControllerBase<TestReceiverController, IReceiverService, IReceiverRepository, ReceiverDto, Receiver, int>
     {
         public TestReceiverController(ILogger<TestReceiverController> logger, IReceiverService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Controllers/Test/TestUserReceiverController.cs

@@ -4,9 +4,9 @@ using EnvelopeGenerator.Application.DTOs;
 using EnvelopeGenerator.Domain.Entities;
 using EnvelopeGenerator.Infrastructure.Contracts;
 
-namespace EnvelopeGenerator.Web.Controllers
+namespace EnvelopeGenerator.Web.Controllers.Test
 {
-    public class TestUserReceiverController : BasicCRUDControllerBase<TestUserReceiverController, IUserReceiverService, IUserReceiverRepository, UserReceiverDto, UserReceiver, int>
+    public class TestUserReceiverController : TestControllerBase<TestUserReceiverController, IUserReceiverService, IUserReceiverRepository, UserReceiverDto, UserReceiver, int>
     {
         public TestUserReceiverController(ILogger<TestUserReceiverController> logger, IUserReceiverService service) : base(logger, service)
         {

EnvelopeGenerator.Web/Program.cs

@@ -10,6 +10,7 @@ using Microsoft.EntityFrameworkCore;
 using NLog;
 using Quartz;
 using NLog.Web;
+using DigitalData.Core.API;
 
 var logger = LogManager.Setup().LoadConfigurationFromAppSettings().GetCurrentClassLogger();
 logger.Info("Logging initialized!");
@@ -27,7 +28,12 @@ try
     builder.Services.AddScoped<EnvelopeOldService>();
 
     // Add services to the container.
-    builder.Services.AddControllersWithViews().AddJsonOptions(q =>
+    builder.Services.AddControllersWithViews(options =>
+    {
+        options.Conventions.Add(new RemoveIfControllerConvention()
+            .AndIf(c => c.ControllerName.StartsWith("Test"))
+            .AndIf(c => !builder.Configuration.GetValue<bool>("AddTestControllers")));
+    }).AddJsonOptions(q =>
     {
         // Prevents serialization error when serializing SvgBitmap in EnvelopeReceiver
         q.JsonSerializerOptions.ReferenceHandler = System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles;
@@ -76,7 +82,7 @@ try
 
     //Auto mapping profiles
     builder.Services.AddAutoMapper(typeof(BasicDtoMappingProfile).Assembly);
-
+    
     var app = builder.Build();
 
     // Configure the HTTP request pipeline.

EnvelopeGenerator.Web/Views/Home/ShowEnvelope.cshtml

@@ -44,7 +44,6 @@
     </div>
 </div>
 }
-
 <script>
     const collapseNav = () => {
         document.addEventListener('click', function (event) {
@@ -68,12 +67,10 @@
     }
 
     var envelopeResponse = @Html.Raw(envelopeResponseJson);
-    console.log(envelopeResponse);
 
     document.addEventListener("DOMContentLoaded", async () => {
         const app = new App("#app", "@ViewData["EnvelopeKey"]", envelopeResponse);
         await app.init();
     })
 </script>
-
 <div id='app' style='background: gray; width: 100vw; height: 100vh; margin: 0 auto;'></div>

EnvelopeGenerator.Web/appsettings.json

@@ -42,5 +42,6 @@
       }
 
     ]
-  }
+  },
+  "AddTestControllers": false
 }