Compare commits

..

47 Commits

Author SHA1 Message Date
cb7d154f64 Refactor LicenseManager registration with factory
Replaces transient LicenseManager registration (with per-injection license key retrieval via MediatR) with a singleton LicenseManagerFactory. This centralizes license management and may improve performance and maintainability.
2026-04-14 21:05:21 +02:00
a3f404b9ae Refactor to use LicenseManagerFactory in PDF jobs
Replaced direct LicenseManager dependencies with LicenseManagerFactory in PDFBurner and PDFMerger classes. This change improves license management flexibility and encapsulation, allowing for better handling of license-related logic.
2026-04-14 21:05:08 +02:00
1f7eb5d4ea Add LicenseManagerFactory for GdPicture license caching
Introduced LicenseManagerFactory to create and cache GdPicture14 LicenseManager instances. The factory retrieves the license key via MediatR, caches it using IMemoryCache with NeverRemove priority, and registers it with LicenseManager. Dependencies are injected, and the license key is preloaded on instantiation.
2026-04-14 21:03:54 +02:00
e1ae3ffccb Increase log verbosity; add InitialJobState config
Changed ASP.NET Core log level to Information in development.
Added Worker.InitialJobState setting to control job startup state,
defaulting FinalizeDocumentJob to Running. Added explanatory
comments for job state values.
2026-04-14 14:47:05 +02:00
3e3bfaa904 Remove GdPictureLicenseKey from WorkerOptions
The GdPictureLicenseKey property was removed from the WorkerOptions class as it is no longer needed. This change helps to simplify the configuration and reduce unused properties.
2026-04-14 13:36:54 +02:00
f8422ed94c Remove unused GdPicture license key retrieval
The ExecuteAsync method in FinalizeDocumentJob.cs no longer retrieves the GdPicture license key, as it is not used in this part of the code. This helps clean up unnecessary code and improves maintainability.
2026-04-14 13:36:28 +02:00
c64c63925e Retrieve GdPicture license key via MediatR from database
Refactored LicenseManager registration to fetch the GdPicture license key from the database using MediatR and ReadThirdPartyModuleLicenseQuery, instead of reading from configuration. Updated using statements accordingly.
2026-04-14 13:25:07 +02:00
2c8ae23203 Add ThirdPartyModule DbSet to EGDbContextBase
Added a DbSet property for ThirdPartyModule entities in EGDbContextBase to enable management and querying of third-party modules via Entity Framework.
2026-04-14 13:21:28 +02:00
b4be718994 Add query/handler to fetch third-party module license text
Introduced ReadThirdPartyModuleLicenseQuery and its handler to retrieve the license text of a third-party module by Id or Name (mutually exclusive), with optional filtering for active modules. Includes validation and exception handling for invalid input, not found, or multiple matches.
2026-04-14 12:39:31 +02:00
33bf5b1a51 Add ThirdPartyModule entity with auditing support
Introduced the ThirdPartyModule entity mapped to the TBDD_3RD_PARTY_MODULES table using Entity Framework. The class includes properties for module details and auditing (added/changed by and when), implements IHasChangedWhen and IHasChangedWho interfaces, and uses conditional compilation for .NET Framework and nullable reference types. Data annotations and schema mapping attributes were added for precise database integration.
2026-04-14 12:15:42 +02:00
6a9792bb57 Refactor WorkerController to manage job state via API
Removed endpoints for starting/stopping/restarting the Worker service. Controller now uses JobStateManager to get and set the state of specific jobs (e.g., FinalizeDocumentJob) through new GET and POST endpoints. Focus shifts from service lifecycle control to job state management.
2026-04-13 16:31:54 +02:00
6954a86358 Add job state check and improve Worker options handling
Refactored Worker to inject JobStateManager and use the full
WorkerOptions object. Now, FinalizeDocumentJob only runs if
its state is State.Running. Delay is also read from options,
improving configuration and control over job execution.
2026-04-13 16:31:00 +02:00
d6c5b63c49 Register JobStateManager as singleton in DI container
JobStateManager is now added as a singleton service, initialized with the InitialJobState from WorkerOptions. This enables consistent state management across the application by providing a shared instance via dependency injection.
2026-04-13 16:30:27 +02:00
8ca360d47e Add InitialJobState and GdPictureLicenseKey to WorkerOptions
Added InitialJobState as a Dictionary<string, State> with an empty default, and introduced a non-nullable GdPictureLicenseKey property to the WorkerOptions class. These additions support initial job state configuration and GdPicture licensing.
2026-04-13 16:29:14 +02:00
2dadefecc5 Add JobStateManager for thread-safe job state tracking
Introduced JobStateManager class to manage job states using a ConcurrentDictionary, supporting thread-safe get/set operations per job type. Added State enum with Running and Stopped values. Allows optional initial state dictionary for job states.
2026-04-13 16:28:40 +02:00
162f066b08 Refactor Worker to use IOptions for configuration
Replaced direct IConfiguration usage in Worker with IOptions<WorkerOptions> for strongly-typed configuration access. Updated delay interval assignment and added necessary namespace import.
2026-04-13 15:25:17 +02:00
6592642945 Update WorkerOptions config section to "Worker"
Changed AddFinalizeDocumentJob to bind WorkerOptions from the "Worker" section in configuration instead of "WorkerOptions" for correct settings mapping.
2026-04-13 15:22:55 +02:00
855f22cf87 Add DelayMilliseconds property to WorkerOptions
Introduced a configurable DelayMilliseconds property to the WorkerOptions class with validation to ensure the value is at least 1 millisecond. This allows for customizable delay settings in worker operations.
2026-04-13 15:22:34 +02:00
726673e277 Add Windows Services hosting support to ServiceHost
Added Microsoft.Extensions.Hosting.WindowsServices package (v8.0.1) to EnvelopeGenerator.ServiceHost.csproj to enable hosting the application as a Windows Service. No other changes were made.
2026-04-13 12:00:01 +02:00
65d615f43e Support inline PDF display or download via query param
Add a 'download' query parameter to DocResultController's GetAsync method. This lets clients choose whether to download the PDF or display it inline by setting the 'download' parameter in the request.
2026-04-13 11:57:46 +02:00
f0f92c5400 Ensure DocResult is included in envelope query handling
Set IncludeDocResult to true on the envelope in the query handler to guarantee the document result is included in responses. This prevents missing document data when processing envelope queries.
2026-04-09 17:10:45 +02:00
7e34f01f6a Include doc result in GetDocResultAsync query
Set IncludeDocResult to true in GetDocResultAsync to ensure the document result is included when retrieving envelope data. This change guarantees that the response contains the necessary document information.
2026-04-09 17:10:08 +02:00
f449767bf9 Add [NotMapped] for Envelope property on .NET Framework
Applied the [NotMapped] attribute to a property in the Envelope class when targeting .NET Framework, ensuring it is not mapped to a database column by Entity Framework in that environment. No changes for other frameworks.
2026-04-09 17:09:40 +02:00
f8ec6065c2 Add IncludeDocResult option to EnvelopeQueryBase
Introduced the IncludeDocResult boolean property to EnvelopeQueryBase, allowing queries to optionally include the DocResult field. By default, DocResult is excluded to prevent unnecessary loading of large binary data.
2026-04-09 16:36:30 +02:00
fabfe80666 Change FinalizeDocumentJob to scoped, add ReportCreator
Changed FinalizeDocumentJob DI registration from singleton to scoped for better instance management. Added ReportCreator as a scoped service. Removed unused EnvelopeGenerator.ServiceHost.Jobs.Infrastructure import.
2026-04-09 16:01:51 +02:00
bdb3863c07 Refactor Kestrel config and add exception middleware
Replaced "UseKestrelConfig" with "UseCustomKestrelEndpoints" and renamed the "Kestrel" section to "ServerConfig" in both Program.cs and appsettings.json. Updated Kestrel server configuration to use the new section. Added ExceptionHandlingMiddleware to the pipeline for global exception handling.
2026-04-09 15:54:38 +02:00
e5295b8302 Add global exception handling middleware
Introduced ExceptionHandlingMiddleware to handle exceptions across the ASP.NET Core request pipeline. The middleware logs exceptions and returns JSON error responses with appropriate HTTP status codes for BadRequestException (400), NotFoundException (404), and generic errors (500). Dependency injection is used for RequestDelegate and ILogger.
2026-04-09 14:47:46 +02:00
00a9cf06da Refactor envelope doc query and improve result validation
Refactored ReadSingleEnvelopeDocResultQuery to remove inheritance from EnvelopeQueryBase and introduce an Envelope property. Enhanced the handler to ensure DocResult is a non-empty byte array before returning, throwing NotFoundException otherwise.
2026-04-09 14:46:04 +02:00
1b387238e8 Configure EnvelopeReport as a keyless entity
Added Entity Framework model configuration for EnvelopeReport in EGDbContextBase, specifying it as a keyless entity using HasNoKey(). This allows EnvelopeReport to be used without a primary key in the database context.
2026-04-09 14:30:23 +02:00
bda4f3dbef Add conditional Windows Service & Kestrel config support
The app now checks configuration values to optionally run as a Windows Service ("UseWindowsService") and/or apply custom Kestrel server settings from the "Kestrel" config section ("UseKestrelConfig"). These changes improve deployment flexibility.
2026-04-09 14:20:04 +02:00
2458d0c07a Configure Kestrel endpoint and hosting options in settings
Added "UseWindowsService" and "UseKestrelConfig" flags to appsettings.json. Defined a custom Kestrel HTTP endpoint at http://localhost:1111 to control how the application is hosted and served.
2026-04-09 14:19:36 +02:00
a72cbab195 Add GET endpoint to return envelope PDF by UUID
Added a new HTTP GET action to DocResultController that accepts a ReadSingleEnvelopeDocResultQuery via query string. The endpoint uses MediatR to retrieve the PDF document and returns it as a file response with the envelope's UUID in the filename and the correct content type.
2026-04-09 14:05:54 +02:00
bcf4e63f7c Add distributed cache, localization, and infra services
- Add DigitalData.Core.API and SQL Server distributed cache dependencies
- Register EnvelopeGenerator.Application project reference
- Configure distributed SQL Server cache and memory cache
- Register infrastructure, application, and user management services
- Set up EF Core with SQL Server and detailed logging
- Enable localization with configurable supported cultures
- Improve modularity and extensibility of service registration
2026-04-09 13:36:40 +02:00
5aabeb4510 Update project to net8.0-windows and enable WinForms
Changed target framework to net8.0-windows to specify Windows platform support. Enabled Windows Forms by setting UseWindowsForms to true in the project file.
2026-04-09 13:34:07 +02:00
32edc6474d Add SupportedCultures and DB connection to appsettings.json
Added "SupportedCultures" for localization support and a "ConnectionStrings" section with a default SQL Server connection string. Also reformatted "AllowedHosts" for consistency.
2026-04-09 13:22:59 +02:00
71bfe3b323 Refactor Worker to resolve FinalizeDocumentJob per scope
Refactored Worker to use IServiceScopeFactory instead of directly injecting FinalizeDocumentJob. Now, a new scope is created in each loop iteration, and FinalizeDocumentJob is resolved from the scoped service provider. This enables FinalizeDocumentJob to use scoped dependencies and improves DI flexibility.
2026-04-09 13:20:02 +02:00
089d2bd1cb Add FinalizeDocumentController and refactor query model
Refactored ReadSingleEnvelopeDocResultQuery to use a parameterless constructor and an Envelope property. Introduced FinalizeDocumentController with a GET endpoint to finalize and return envelope documents as PDFs, supporting force regeneration. Added dependency injection for IMediator and FinalizeDocumentJob. Includes a TODO to migrate forceRegenerate logic into the job.
2026-04-09 10:55:13 +02:00
65c72bcf77 Add DocResultController for envelope PDF download
Introduced DocResultController with a GET endpoint to retrieve envelope PDF documents by sending a query via MediatR. The controller returns the PDF as a file response with an appropriate filename and content type. Added necessary using directives for MediatR, ASP.NET Core MVC, and the application query.
2026-04-09 10:30:04 +02:00
2d8375f26a Refactor envelope query to throw on not found or multiple
Refactored ReadSingleEnvelopeQuery and its handler to return EnvelopeDto directly and throw NotFoundException or BadRequestException when no or multiple envelopes are found, instead of returning null. Updated imports to include custom exceptions.
2026-04-09 10:28:13 +02:00
a7cfb099fa Add query/handler for envelope document retrieval
Introduced ReadSingleEnvelopeDocResultQuery and its handler to fetch an envelope's document as a byte array via MediatR. Throws NotFoundException if the document is missing. Includes XML documentation for clarity.
2026-04-09 10:26:44 +02:00
7a0d4e2fa7 Remove MediatorGetOrContext; add ExecuteAsync overloads
Removed MediatorGetOrContext.cs, eliminating the fluent API for handling null or empty MediatR responses with custom exceptions. Added two ExecuteAsync overloads to FinalizeDocumentJob: one for processing a single EnvelopeDto and another for processing all envelopes with the EnvelopeCompletelySigned status.
2026-04-09 10:25:59 +02:00
3955ee9f39 Refactor Mediator GetOr API for naming consistency
Renamed MediatorExtensions to MediatorGetOrContext and GetOrContext<TResponse> to MediatorGetOrContext<TResponse> for consistent naming. Moved the GetOr extension method into the new static class. Updated XML docs and reorganized declarations; no functional changes.
2026-04-08 15:34:39 +02:00
9bdf24d7d5 Refactor MediatorExtensions to fluent GetOr/Throw API
Replaced GetOrThrow methods with a fluent GetOr/Throw pattern for handling null or empty MediatR responses. Introduced GetOrContext<TResponse> struct with Throw, ThrowNotFound, ThrowInvalidOperation, and ThrowBadRequest methods. Updated all tests to use the new API and added coverage for new exception types. Improved XML docs and performed minor code cleanup.
2026-04-08 15:26:23 +02:00
993ca82596 Rename MediatR extensions to GetOrThrow for ISender
Renamed SendOrThrowAsync and SendOrNotFoundAsync extension methods for IMediator to GetOrThrow for ISender, following MediatR best practices. Updated all usages, XML docs, and tests to use ISender and the new method names. Replaced StubMediator with StubSender in tests. Functionality remains the same, but code now aligns with modern MediatR conventions.
2026-04-08 14:01:24 +02:00
ce9958a8b1 Add MediatorExtensions tests and refactor CreateEnvelopeCommand
Introduce MediatorExtensionsTests to cover SendOrThrowAsync and SendOrNotFoundAsync extension methods for IMediator, including edge cases and cancellation. Refactor CreateEnvelopeCommand in Fake.cs to use Authorize(userId) instead of setting UserId directly. Add test stubs for IMediator and IRequest to support isolated testing.
2026-04-08 13:46:27 +02:00
6c54473d5a Refactor MediatorExtensions for flexible exception handling
Generalize null/empty response handling with SendOrThrowAsync<TResponse, TException>, allowing custom exceptions via a factory delegate. SendOrNotFoundAsync now wraps this method for NotFoundException. Improves type safety, flexibility, and XML docs; avoids treating strings as collections.
2026-04-08 13:44:19 +02:00
9ad4352e02 Add MediatorExtensions for not-found handling in MediatR
Introduced MediatorExtensions with SendOrNotFoundAsync methods to enforce non-null and non-empty responses from MediatR requests. These extensions throw NotFoundException when responses are null or empty, centralizing not-found logic and improving error handling.
2026-04-08 13:25:34 +02:00
26 changed files with 889 additions and 94 deletions

View File

@@ -71,6 +71,7 @@ public class EnvelopeController : ControllerBase
[HttpGet("doc-result")]
public async Task<IActionResult> GetDocResultAsync([FromQuery] ReadEnvelopeQuery query, [FromQuery] bool view = false)
{
query.IncludeDocResult = true;
var envelopes = await _mediator.Send(query.Authorize(User.GetId()));
var envelope = envelopes.FirstOrDefault();

View File

@@ -14,4 +14,10 @@ public record EnvelopeQueryBase
/// Die universell eindeutige Kennung des Umschlags.
/// </summary>
public virtual string? Uuid { get; set; }
/// <summary>
/// Wenn gesetzt, wird das DocResult-Feld in der Abfrage einbezogen.
/// Standardmäßig wird DocResult nicht geladen, um große Binärdaten zu vermeiden.
/// </summary>
public bool IncludeDocResult { get; set; } = false;
}

View File

@@ -0,0 +1,48 @@
using MediatR;
using EnvelopeGenerator.Application.Common.Dto;
using DigitalData.Core.Exceptions;
namespace EnvelopeGenerator.Application.Envelopes.Queries;
/// <summary>
/// Repräsentiert eine Abfrage für Umschläge.
/// </summary>
public record ReadSingleEnvelopeDocResultQuery() : IRequest<byte[]>
{
/// <summary>
///
/// </summary>
public ReadSingleEnvelopeQuery Envelope { get; set; } = null!;
}
/// <summary>
/// Verarbeitet <see cref="ReadEnvelopeQuery"/> und liefert passende <see cref="EnvelopeDto"/>-Ergebnisse.
/// </summary>
public class ReadSingleEnvelopeDocResultQueryHandler : IRequestHandler<ReadSingleEnvelopeDocResultQuery, byte[]>
{
private readonly IMediator _mediator;
/// <summary>
///
/// </summary>
/// <param name="mediator"></param>
public ReadSingleEnvelopeDocResultQueryHandler(IMediator mediator)
{
_mediator = mediator;
}
/// <summary>
///
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public async Task<byte[]> Handle(ReadSingleEnvelopeDocResultQuery request, CancellationToken cancellationToken)
{
request.Envelope.IncludeDocResult = true;
var result = await _mediator.Send(request.Envelope, cancellationToken);
return result.DocResult is byte[] docResult && docResult.Length > 0
? docResult
: throw new NotFoundException($"Document for Envelope with ID {request.Envelope.Id} not found");
}
}

View File

@@ -5,13 +5,14 @@ using AutoMapper;
using DigitalData.Core.Abstraction.Application.Repository;
using EnvelopeGenerator.Domain.Entities;
using Microsoft.EntityFrameworkCore;
using DigitalData.Core.Exceptions;
namespace EnvelopeGenerator.Application.Envelopes.Queries;
/// <summary>
/// Repräsentiert eine Abfrage für einen einzelnen Umschlag.
/// </summary>
public record ReadSingleEnvelopeQuery : EnvelopeQueryBase, IRequest<EnvelopeDto?>
public record ReadSingleEnvelopeQuery : EnvelopeQueryBase, IRequest<EnvelopeDto>
{
/// <summary>
/// Optionaler Benutzerfilter; wenn gesetzt, werden nur Umschläge des Benutzers geladen.
@@ -27,7 +28,7 @@ public record ReadSingleEnvelopeQuery : EnvelopeQueryBase, IRequest<EnvelopeDto?
/// <summary>
/// Verarbeitet <see cref="ReadSingleEnvelopeQuery"/> und liefert ein einzelnes <see cref="EnvelopeDto"/>-Ergebnis.
/// </summary>
public class ReadSingleEnvelopeQueryHandler : IRequestHandler<ReadSingleEnvelopeQuery, EnvelopeDto?>
public class ReadSingleEnvelopeQueryHandler : IRequestHandler<ReadSingleEnvelopeQuery, EnvelopeDto>
{
private readonly IRepository<Envelope> _repository;
private readonly IMapper _mapper;
@@ -49,7 +50,7 @@ public class ReadSingleEnvelopeQueryHandler : IRequestHandler<ReadSingleEnvelope
/// <param name="request"></param>
/// <param name="cancel"></param>
/// <returns></returns>
public async Task<EnvelopeDto?> Handle(ReadSingleEnvelopeQuery request, CancellationToken cancel)
public async Task<EnvelopeDto> Handle(ReadSingleEnvelopeQuery request, CancellationToken cancel)
{
var query = _repository.Query;
@@ -61,11 +62,17 @@ public class ReadSingleEnvelopeQueryHandler : IRequestHandler<ReadSingleEnvelope
if (request.Uuid is string uuid)
query = query.Where(e => e.Uuid == uuid);
var envelope = await query
var envelopes = await query
.Include(e => e.Documents)
.FirstOrDefaultAsync(cancel);
.Take(2)
.ToListAsync(cancel);
return envelope is null ? null : _mapper.Map<EnvelopeDto>(envelope);
if (envelopes.Count > 1)
throw new BadRequestException($"Multiple envelopes found for the given criteria: Id={request.Id}, Uuid={request.Uuid}, UserId={request.UserId}");
return envelopes.SingleOrDefault() is Envelope envelope
? _mapper.Map<EnvelopeDto>(envelope)
: throw new NotFoundException($"Envelope with Id={request.Id}, Uuid={request.Uuid} not found");
}
}
}

View File

@@ -0,0 +1,92 @@
using DigitalData.Core.Abstraction.Application.Repository;
using DigitalData.Core.Exceptions;
using EnvelopeGenerator.Domain.Entities;
using MediatR;
using Microsoft.EntityFrameworkCore;
namespace EnvelopeGenerator.Application.ThirdPartyModules.Queries;
/// <summary>
/// Query to read the license text of a third-party module.
/// Either <see cref="Id"/> or <see cref="Name"/> must be provided, but not both.
/// </summary>
public record ReadThirdPartyModuleLicenseQuery : IRequest<string>
{
/// <summary>
/// The unique identifier of the third-party module (optional).
/// </summary>
public int? Id { get; init; }
/// <summary>
/// The name of the third-party module (optional).
/// </summary>
public string? Name { get; init; }
/// <summary>
/// Whether to filter only active modules. Defaults to <c>true</c>.
/// </summary>
public bool Active { get; init; } = true;
}
/// <summary>
/// Handles <see cref="ReadThirdPartyModuleLicenseQuery"/> and returns the license text of a third-party module.
/// </summary>
public class ReadThirdPartyModuleLicenseQueryHandler : IRequestHandler<ReadThirdPartyModuleLicenseQuery, string>
{
private readonly IRepository<ThirdPartyModule> _repository;
/// <summary>
/// Initializes a new instance of the <see cref="ReadThirdPartyModuleLicenseQueryHandler"/> class.
/// </summary>
/// <param name="repository">The repository for accessing third-party modules.</param>
public ReadThirdPartyModuleLicenseQueryHandler(IRepository<ThirdPartyModule> repository)
{
_repository = repository;
}
/// <summary>
/// Handles the query by filtering on Id or Name and returning the license text.
/// </summary>
/// <param name="request">The query parameters.</param>
/// <param name="cancel">A cancellation token.</param>
/// <returns>The license text of the matching third-party module.</returns>
/// <exception cref="BadRequestException">
/// Thrown when neither Id nor Name is provided, or when both are provided.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Thrown when multiple modules match the given criteria, indicating a data integrity issue.
/// </exception>
/// <exception cref="NotFoundException">
/// Thrown when no module matches the given criteria.
/// </exception>
public async Task<string> Handle(ReadThirdPartyModuleLicenseQuery request, CancellationToken cancel)
{
if (request.Id is null && request.Name is null)
throw new BadRequestException("Either Id or Name must be provided.");
if (request.Id is not null && request.Name is not null)
throw new BadRequestException("Only one of Id or Name must be provided, not both.");
var query = _repository.Query
.Where(m => m.Active == request.Active);
if (request.Id is int id)
query = query.Where(m => m.Id == id);
if (request.Name is string name)
query = query.Where(m => m.Name == name);
var modules = await query
.Take(2)
.ToListAsync(cancel);
if (modules.Count > 1)
throw new InvalidOperationException(
$"Data integrity violation: multiple third-party modules found for the given criteria (Id={request.Id}, Name={request.Name}, Active={request.Active}).");
return modules.SingleOrDefault() is ThirdPartyModule module
? module.License
: throw new NotFoundException(
$"Third-party module not found for the given criteria (Id={request.Id}, Name={request.Name}, Active={request.Active}).");
}
}

View File

@@ -140,7 +140,9 @@ namespace EnvelopeGenerator.Domain.Entities
= false;
#endif
#if NETFRAMEWORK
[NotMapped]
#endif
[Column("DOC_RESULT")]
public byte[]
#if nullable

View File

@@ -0,0 +1,61 @@
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using EnvelopeGenerator.Domain.Interfaces.Auditing;
#if NETFRAMEWORK
using System;
#endif
namespace EnvelopeGenerator.Domain.Entities
{
[Table("TBDD_3RD_PARTY_MODULES", Schema = "dbo")]
public class ThirdPartyModule : IHasChangedWhen, IHasChangedWho
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
[Column("GUID")]
public int Id { get; set; }
[Required]
[Column("ACTIVE", TypeName = "bit")]
public bool Active { get; set; }
[Required]
[Column("NAME", TypeName = "varchar(50)")]
public string Name { get; set; }
[Column("DESCRIPTION", TypeName = "varchar(500)")]
public string
#if nullable
?
#endif
Description { get; set; }
[Required]
[Column("LICENSE", TypeName = "varchar(max)")]
public string License { get; set; }
[Required]
[Column("VERSION", TypeName = "varchar(20)")]
public string Version { get; set; }
[Column("ADDED_WHO", TypeName = "varchar(50)")]
public string
#if nullable
?
#endif
AddedWho { get; set; }
[Column("ADDED_WHEN", TypeName = "datetime")]
public DateTime? AddedWhen { get; set; }
[Column("CHANGED_WHO", TypeName = "varchar(50)")]
public string
#if nullable
?
#endif
ChangedWho { get; set; }
[Column("CHANGED_WHEN", TypeName = "datetime")]
public DateTime? ChangedWhen { get; set; }
}
}

View File

@@ -81,6 +81,8 @@ public abstract class EGDbContextBase : DbContext
public DbSet<EnvelopeReport> EnvelopeReports { get; set; }
public DbSet<ThirdPartyModule> ThirdPartyModules { get; set; }
private readonly DbTriggerParams _triggers;
private readonly ILogger
@@ -202,6 +204,10 @@ public abstract class EGDbContextBase : DbContext
.HasForeignKey(annot => annot.ElementId);
#endregion
#region EnvelopeReport
modelBuilder.Entity<EnvelopeReport>().HasNoKey();
#endregion
#region Trigger
// Configure entities to handle database triggers
void AddTrigger<T>() where T : class => _triggers

View File

@@ -0,0 +1,21 @@
using EnvelopeGenerator.Application.Envelopes.Queries;
using MediatR;
using Microsoft.AspNetCore.Mvc;
namespace EnvelopeGenerator.ServiceHost.Controllers;
[Route("api/[controller]")]
[ApiController]
public class DocResultController(IMediator mediator) : ControllerBase
{
[HttpGet]
public async Task<IActionResult> GetAsync([FromQuery] ReadSingleEnvelopeDocResultQuery query, [FromQuery] bool download = false, CancellationToken cancel = default)
{
var bytes = await mediator.Send(query, cancel);
if (download)
return File(bytes, "application/pdf", $"envelope_{query.Envelope.Uuid}.pdf");
return File(bytes, "application/pdf");
}
}

View File

@@ -0,0 +1,29 @@
using EnvelopeGenerator.Application.Envelopes.Queries;
using EnvelopeGenerator.ServiceHost.Jobs;
using MediatR;
using Microsoft.AspNetCore.Mvc;
namespace EnvelopeGenerator.ServiceHost.Controllers;
/// <summary>
///
/// </summary>
/// <param name="mediator"></param>
/// <param name="job"></param>
[Route("api/[controller]")]
[ApiController]
public class FinalizeDocumentController(IMediator mediator, FinalizeDocumentJob job) : ControllerBase
{
[HttpGet]
public async Task<IActionResult> FinalizeEnvelopeDocument([FromQuery] ReadSingleEnvelopeQuery query, [FromQuery] bool forceRegenerate = false, CancellationToken cancel = default)
{
var envelope = await mediator.Send(query, cancel);
// TODO: migrate forceRegenerate input to FinalizeDocumentJob as property and remove this check from controller
if (envelope.DocResult is null || forceRegenerate)
await job.ExecuteAsync(envelope, cancel);
var docResult = await mediator.Send(new ReadSingleEnvelopeDocResultQuery() { Envelope = query }, cancel);
return File(docResult, "application/pdf", $"envelope_{query.Uuid}.pdf");
}
}

View File

@@ -1,44 +1,21 @@
using Microsoft.AspNetCore.Mvc;
using EnvelopeGenerator.ServiceHost.Jobs;
using Microsoft.AspNetCore.Mvc;
namespace EnvelopeGenerator.ServiceHost.Controllers;
[Route("api/[controller]")]
[ApiController]
public class WorkerController(IEnumerable<IHostedService> hostedServices, ILogger<WorkerController> logger) : ControllerBase
public class WorkerController(JobStateManager jobStateManager) : ControllerBase
{
private Worker? Worker => hostedServices.OfType<Worker>().FirstOrDefault();
private readonly JobStateManager _jobStateManager = jobStateManager;
[HttpPost("stop")]
public async Task<IActionResult> Stop(CancellationToken cancel)
[HttpGet(nameof(FinalizeDocumentJob))]
public IActionResult GetStateOfFinalizeDocumentJob() => Ok(_jobStateManager.GetState<FinalizeDocumentJob>());
[HttpPost(nameof(FinalizeDocumentJob))]
public IActionResult SetStateOfFinalizeDocumentJob([FromQuery] State state)
{
if (Worker is null)
return NotFound();
logger.LogInformation("Stopping Worker via API request.");
await Worker.StopAsync(cancel);
return Ok();
}
[HttpPost("start")]
public async Task<IActionResult> Start(CancellationToken cancel)
{
if (Worker is null)
return NotFound();
logger.LogInformation("Starting Worker via API request.");
await Worker.StartAsync(cancel);
return Ok();
}
[HttpPost("restart")]
public async Task<IActionResult> Restart(CancellationToken cancel)
{
if (Worker is null)
return NotFound();
logger.LogInformation("Restarting Worker via API request.");
await Worker.StopAsync(cancel);
await Worker.StartAsync(cancel);
_jobStateManager.SetState<FinalizeDocumentJob>(state);
return Ok();
}
}

View File

@@ -1,12 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<TargetFramework>net8.0-windows</TargetFramework>
<UseWindowsForms>true</UseWindowsForms>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="DigitalData.Core.API" Version="2.2.1" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
<PackageReference Include="GdPicture" Version="14.3.3" />
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.1.4" />
@@ -18,9 +20,12 @@
<PackageReference Include="System.Drawing.Common" Version="8.0.16" />
<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
<PackageReference Include="DevExpress.Reporting.Core" Version="24.2.*" />
<PackageReference Include="Microsoft.Extensions.Caching.SqlServer" Version="8.0.17" />
<PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="8.0.1" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\EnvelopeGenerator.Application\EnvelopeGenerator.Application.csproj" />
<ProjectReference Include="..\EnvelopeGenerator.Domain\EnvelopeGenerator.Domain.csproj" />
<ProjectReference Include="..\EnvelopeGenerator.Infrastructure\EnvelopeGenerator.Infrastructure.csproj" />
<ProjectReference Include="..\EnvelopeGenerator.PdfEditor\EnvelopeGenerator.PdfEditor.csproj" />

View File

@@ -1,6 +1,5 @@
using EnvelopeGenerator.ServiceHost.Jobs;
using EnvelopeGenerator.ServiceHost.Jobs.FinalizeDocument;
using EnvelopeGenerator.ServiceHost.Jobs.Infrastructure;
using GdPicture14;
using Microsoft.Extensions.Options;
@@ -11,23 +10,23 @@ public static class DependencyInjection
[Obsolete("Check obsoleted services")]
public static IServiceCollection AddFinalizeDocumentJob(this IServiceCollection services, IConfiguration configuration)
{
services.Configure<WorkerOptions>(configuration.GetSection(nameof(WorkerOptions)));
services.AddSingleton<FinalizeDocumentJob>();
services.Configure<WorkerOptions>(configuration.GetSection("Worker"));
services.AddSingleton(provider =>
{
var options = provider.GetRequiredService<IOptions<WorkerOptions>>().Value;
var manager = new JobStateManager(options.InitialJobState);
return manager;
});
services.AddScoped<FinalizeDocumentJob>();
services.AddScoped<ActionService>();
services.AddSingleton<TempFiles>();
services.AddScoped<PDFBurner>();
services.AddScoped<PDFMerger>();
services.AddScoped<ReportCreator>();
//TODO: Check lifetime of services. They might be singleton or scoped.
services.AddTransient<GdViewer>();
// Add LicenseManager
services.AddTransient(provider =>
{
var options = provider.GetRequiredService<IOptions<WorkerOptions>>().Value;
var licenseManager = new LicenseManager();
licenseManager.RegisterKEY(options.GdPictureLicenseKey);
return licenseManager;
});
services.AddSingleton<LicenseManagerFactory>();
services.AddTransient<AnnotationManager>();
return services;

View File

@@ -4,6 +4,7 @@ using EnvelopeGenerator.Domain.Entities;
using EnvelopeGenerator.Infrastructure;
using EnvelopeGenerator.PdfEditor;
using EnvelopeGenerator.ServiceHost.Exceptions;
using EnvelopeGenerator.ServiceHost.Jobs;
using GdPicture14;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Options;
@@ -11,16 +12,7 @@ using Newtonsoft.Json;
namespace EnvelopeGenerator.ServiceHost.Jobs.FinalizeDocument;
//TODO: check if licence manager is needed as a dependency to
/// <summary>
///
/// </summary>
/// <param name="workerOptions"></param>
/// <param name="context2"></param>
/// <param name="logger2"></param>
/// <param name="licenseManager"></param>
/// <param name="annotationManager2"></param>
public class PDFBurner(IOptions<WorkerOptions> workerOptions, EGDbContext context, ILogger<PDFBurner> logger, LicenseManager licenseManager, AnnotationManager manager)
public class PDFBurner(IOptions<WorkerOptions> workerOptions, EGDbContext context, ILogger<PDFBurner> logger, LicenseManagerFactory licenseManagerFactory, AnnotationManager manager)
{
private readonly WorkerOptions.PDFBurnerOptions _options = workerOptions.Value.PdfBurner;

View File

@@ -1,4 +1,5 @@
using EnvelopeGenerator.ServiceHost.Exceptions;
using EnvelopeGenerator.ServiceHost.Jobs;
using GdPicture14;
using Microsoft.Extensions.Options;
@@ -7,16 +8,16 @@ namespace EnvelopeGenerator.ServiceHost.Jobs.FinalizeDocument;
public class PDFMerger
{
private readonly AnnotationManager _manager;
private readonly LicenseManager _licenseManager;
private readonly LicenseManagerFactory _licenseManagerFactory;
private const bool AllowRasterization = true;
private const bool AllowVectorization = true;
private readonly PdfConversionConformance _pdfaConformanceLevel = PdfConversionConformance.PDF_A_1b;
public PDFMerger(LicenseManager licenseManager, AnnotationManager annotationManager)
public PDFMerger(LicenseManagerFactory licenseManagerFactory, AnnotationManager annotationManager)
{
_licenseManager = licenseManager;
_licenseManagerFactory = licenseManagerFactory;
_manager = annotationManager;
}

View File

@@ -38,7 +38,6 @@ public class FinalizeDocumentJob(IOptions<WorkerOptions> options, ILogger<Finali
public async Task ExecuteAsync(IEnumerable<EnvelopeDto> envelopes, CancellationToken cancel = default)
{
var gdPictureKey = _options.GdPictureLicenseKey;
tempFiles.Create();
var jobId = typeof(FinalizeDocumentJob).FullName;
@@ -60,6 +59,8 @@ public class FinalizeDocumentJob(IOptions<WorkerOptions> options, ILogger<Finali
}
}
public Task ExecuteAsync(EnvelopeDto envelope, CancellationToken cancel = default) => ExecuteAsync([envelope], cancel);
public async Task ExecuteAsync(CancellationToken cancel = default)
{
var envelopes = await mediator.Send(new ReadEnvelopeQuery()

View File

@@ -0,0 +1,19 @@
using AngleSharp.Common;
using System.Collections.Concurrent;
namespace EnvelopeGenerator.ServiceHost.Jobs;
public class JobStateManager(Dictionary<string, State>? initialState = null)
{
private readonly ConcurrentDictionary<Type, State> _states = new();
public State GetState<TJob>() => _states.GetOrAdd(typeof(TJob), type => initialState?.GetOrDefault(type.Name, State.Stopped) ?? State.Stopped);
public State SetState<TJob>(State state) => _states[typeof(TJob)] = state;
}
public enum State
{
Running,
Stopped
}

View File

@@ -0,0 +1,39 @@
using EnvelopeGenerator.Application.ThirdPartyModules.Queries;
using GdPicture14;
using MediatR;
using Microsoft.Extensions.Caching.Memory;
namespace EnvelopeGenerator.ServiceHost.Jobs;
public class LicenseManagerFactory
{
private static readonly string _cacheKey = Guid.NewGuid().ToString();
private readonly IServiceScopeFactory scopeFactory;
private readonly IMemoryCache cache;
public LicenseManagerFactory(IServiceScopeFactory scopeFactory, IMemoryCache cache)
{
this.scopeFactory = scopeFactory;
this.cache = cache;
_ = CreateAsync(); // Preload the license key into the cache
}
public async Task<LicenseManager> CreateAsync(CancellationToken cancellationToken = default)
{
var key = await GetLicenseKeyAsync(cancellationToken);
var licenseManager = new LicenseManager();
licenseManager.RegisterKEY(key);
return licenseManager;
}
public async Task<string> GetLicenseKeyAsync(CancellationToken cancellationToken = default)
{
return await cache.GetOrCreateAsync(_cacheKey, async entry =>
{
entry.Priority = CacheItemPriority.NeverRemove;
using var scope = scopeFactory.CreateScope();
var mediator = scope.ServiceProvider.GetRequiredService<IMediator>();
return await mediator.Send(new ReadThirdPartyModuleLicenseQuery { Name = "GdPicture", Active =true }, cancellationToken);
}) ?? throw new InvalidOperationException("License key could not be retrieved.");
}
}

View File

@@ -1,11 +1,22 @@
using EnvelopeGenerator.ServiceHost.Jobs.FinalizeDocument;
using System.Drawing;
namespace EnvelopeGenerator.ServiceHost.Jobs;
public class WorkerOptions
{
public string GdPictureLicenseKey { get; set; } = null!;
private int _delayMilliseconds = 1000;
public int DelayMilliseconds
{
get => _delayMilliseconds;
set
{
if (value < 1)
throw new ArgumentOutOfRangeException(nameof(value), "Delay must be at least 1 millisecond.");
_delayMilliseconds = value;
}
}
public Dictionary<string, State> InitialJobState { get; set; } = [];
public PDFBurnerOptions PdfBurner { get; set; } = new();

View File

@@ -0,0 +1,75 @@
namespace EnvelopeGenerator.ServiceHost.Middleware;
using DigitalData.Core.Exceptions;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System.Net;
using System.Text.Json;
/// <summary>
/// Middleware for handling exceptions globally in the application.
/// Captures exceptions thrown during the request pipeline execution,
/// logs them, and returns an appropriate HTTP response with a JSON error message.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="ExceptionHandlingMiddleware"/> class.
/// </remarks>
/// <param name="next">The next middleware in the request pipeline.</param>
/// <param name="logger">The logger instance for logging exceptions.</param>
public class ExceptionHandlingMiddleware(RequestDelegate next, ILogger<ExceptionHandlingMiddleware> logger)
{
/// <summary>
/// Invokes the middleware to handle the HTTP request.
/// </summary>
/// <param name="context">The HTTP context of the current request.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public async Task InvokeAsync(HttpContext context)
{
try
{
await next(context); // Continue down the pipeline
}
catch (Exception ex)
{
await HandleExceptionAsync(context, ex, logger);
}
}
/// <summary>
/// Handles exceptions by logging them and writing an appropriate JSON response.
/// </summary>
/// <param name="context">The HTTP context of the current request.</param>
/// <param name="exception">The exception that occurred.</param>
/// <param name="logger">The logger instance for logging the exception.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
private static async Task HandleExceptionAsync(HttpContext context, Exception exception, ILogger logger)
{
context.Response.ContentType = "application/json";
string message;
switch (exception)
{
case BadRequestException badRequestEx:
context.Response.StatusCode = (int)HttpStatusCode.BadRequest;
message = badRequestEx.Message;
break;
case NotFoundException notFoundEx:
context.Response.StatusCode = (int)HttpStatusCode.NotFound;
message = notFoundEx.Message;
break;
default:
logger.LogError(exception, "Unhandled exception occurred.");
context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
message = "An unexpected error occurred.";
break;
}
await context.Response.WriteAsync(JsonSerializer.Serialize(new
{
message
}));
}
}

View File

@@ -1,20 +1,73 @@
using DigitalData.UserManager.DependencyInjection;
using EnvelopeGenerator.Application;
using EnvelopeGenerator.Infrastructure;
using EnvelopeGenerator.ServiceHost;
using EnvelopeGenerator.ServiceHost.Extensions;
using EnvelopeGenerator.ServiceHost.Middleware;
using Microsoft.AspNetCore.Localization;
using Microsoft.EntityFrameworkCore;
using System.Globalization;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
#region Kestrel & Windows Service Configuration
if (builder.Configuration.GetValue<bool>("UseWindowsService"))
{
builder.Host.UseWindowsService();
}
if (builder.Configuration.GetValue<bool>("UseCustomKestrelEndpoints"))
{
builder.WebHost.ConfigureKestrel((context, serverOptions) =>
{
var serverConfigSection = context.Configuration.GetSection("ServerConfig");
serverOptions.Configure(serverConfigSection);
});
}
#endregion
var config = builder.Configuration;
var connStr = config.GetConnectionString("Default") ??
throw new InvalidOperationException("Connection string 'Default' is missing in the configuration.");
#region Service configuration
builder.Services.AddControllers();
builder.Services.AddFinalizeDocumentJob(builder.Configuration);
builder.Services.AddHostedService<Worker>();
builder.Services.AddDistributedSqlServerCache(options =>
{
options.ConnectionString = connStr;
options.SchemaName = "dbo";
options.TableName = "TBDD_CACHE";
});
#pragma warning disable CS0618
builder.Services.AddFinalizeDocumentJob(config);
builder.Services.AddEnvelopeGeneratorInfrastructureServices(
opt =>
{
opt.AddDbTriggerParams(config);
opt.AddDbContext((provider, options) =>
{
var logger = provider.GetRequiredService<ILogger<EGDbContext>>();
options.UseSqlServer(connStr)
.LogTo(log => logger.LogInformation("{log}", log), Microsoft.Extensions.Logging.LogLevel.Trace)
.EnableSensitiveDataLogging()
.EnableDetailedErrors();
});
});
builder.Services.AddEnvelopeGeneratorServices(config);
builder.Services.AddMemoryCache();
builder.Services.AddUserManager<EGDbContext>();
#pragma warning restore CS0618
builder.Services.AddLocalization();
#endregion
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
var app = builder.Build();
app.UseMiddleware<ExceptionHandlingMiddleware>();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
@@ -22,10 +75,22 @@ if (app.Environment.IsDevelopment())
app.UseSwaggerUI();
}
#region Localizer
var supportedCultureNames = config.GetSection("SupportedCultures").Get<string[]>() ?? ["de-DE", "en-US"];
var supportedCultures = supportedCultureNames.Select(cName => new CultureInfo(cName)).ToList();
var requestLocalizationOptions = new RequestLocalizationOptions
{
SupportedCultures = supportedCultures,
SupportedUICultures = supportedCultures
};
requestLocalizationOptions.RequestCultureProviders.Add(new QueryStringRequestCultureProvider());
app.UseRequestLocalization(requestLocalizationOptions);
#endregion
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();
app.Run();

View File

@@ -1,18 +1,21 @@
using EnvelopeGenerator.ServiceHost.Jobs;
using Microsoft.Extensions.Options;
namespace EnvelopeGenerator.ServiceHost;
public class Worker : BackgroundService
{
private readonly ILogger<Worker> _logger;
private readonly int _delayMilliseconds;
private readonly FinalizeDocumentJob _finalizeDocumentJob;
private readonly WorkerOptions _options;
private readonly JobStateManager _jobStateManager;
private readonly IServiceScopeFactory _scopeFactory;
public Worker(ILogger<Worker> logger, IConfiguration configuration, FinalizeDocumentJob finalizeDocumentJob)
public Worker(ILogger<Worker> logger, IOptions<WorkerOptions> options, JobStateManager jobStateManager, IServiceScopeFactory scopeFactory)
{
_logger = logger;
_delayMilliseconds = Math.Max(1, configuration.GetValue("Worker:DelayMilliseconds", 1000));
_finalizeDocumentJob = finalizeDocumentJob;
_options = options.Value;
_jobStateManager = jobStateManager;
_scopeFactory = scopeFactory;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
@@ -24,8 +27,14 @@ public class Worker : BackgroundService
_logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now);
}
await _finalizeDocumentJob.ExecuteAsync(stoppingToken);
await Task.Delay(_delayMilliseconds, stoppingToken);
if (_jobStateManager.GetState<FinalizeDocumentJob>() == State.Running)
{
using var scope = _scopeFactory.CreateScope();
var finalizeDocumentJob = scope.ServiceProvider.GetRequiredService<FinalizeDocumentJob>();
await finalizeDocumentJob.ExecuteAsync(stoppingToken);
}
await Task.Delay(_options.DelayMilliseconds, stoppingToken);
}
}
}
}

View File

@@ -2,7 +2,7 @@
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
"Microsoft.AspNetCore": "Information"
}
}
}

View File

@@ -6,7 +6,24 @@
}
},
"Worker": {
"DelayMilliseconds": 1000
"DelayMilliseconds": 1000,
// InitialJobState: State values are 0 = Running, 1 = Stopped. Defaults to 1 (Stopped) if not specified.
"InitialJobState": {
"FinalizeDocumentJob": 0
}
},
"AllowedHosts": "*"
}
"AllowedHosts": "*",
"SupportedCultures": [ "de-DE", "en-US" ],
"ConnectionStrings": {
"Default": "Server=SDD-VMP04-SQL17\\DD_DEVELOP01;Database=DD_ECM;User Id=sa;Password=dd;Encrypt=false;TrustServerCertificate=True;"
},
"UseWindowsService": false,
"UseCustomKestrelEndpoints": false,
"ServerConfig": {
"Endpoints": {
"Http": {
"Url": "http://localhost:1111"
}
}
}
}

View File

@@ -193,13 +193,17 @@ public static class Extensions
#endregion
#region Envelope
public static CreateEnvelopeCommand CreateEnvelopeCommand(this Faker fake, int userId) => new()
public static CreateEnvelopeCommand CreateEnvelopeCommand(this Faker fake, int userId)
{
Message = fake.Lorem.Paragraph(fake.Random.Number(2, 5)),
Title = fake.Lorem.Words(fake.Random.Number(3, 4)).Join(" "),
UserId = userId,
UseSQLExecutor = false
};
var cmd = new CreateEnvelopeCommand
{
Message = fake.Lorem.Paragraph(fake.Random.Number(2, 5)),
Title = fake.Lorem.Words(fake.Random.Number(3, 4)).Join(" "),
UseSQLExecutor = false
};
cmd.Authorize(userId);
return cmd;
}
public static List<CreateEnvelopeCommand> CreateEnvelopeCommands(this Faker fake, params int[] userIDs)
=> Enumerable.Range(0, userIDs.Length)

View File

@@ -0,0 +1,308 @@
using DigitalData.Core.Exceptions;
using EnvelopeGenerator.Application.Common.Extensions;
using MediatR;
namespace EnvelopeGenerator.Tests.Application;
[TestFixture]
public class MediatorExtensionsTests
{
#region Stub infrastructure
private sealed class StubRequest<TResponse> : IRequest<TResponse?> { }
/// <summary>
/// Minimal <see cref="ISender"/> stub that returns a pre-configured response for any <see cref="ISender.Send{TResponse}"/> call.
/// </summary>
private sealed class StubSender : ISender
{
private readonly object? _response;
public StubSender(object? response) => _response = response;
public Task<TResponse> Send<TResponse>(IRequest<TResponse> request, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
return Task.FromResult((TResponse)_response!);
}
public Task Send<TRequest>(TRequest request, CancellationToken cancellationToken = default) where TRequest : IRequest
{
cancellationToken.ThrowIfCancellationRequested();
return Task.CompletedTask;
}
public Task<object?> Send(object request, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
return Task.FromResult(_response);
}
public IAsyncEnumerable<TResponse> CreateStream<TResponse>(IStreamRequest<TResponse> request, CancellationToken cancellationToken = default)
=> throw new NotImplementedException();
public IAsyncEnumerable<object?> CreateStream(object request, CancellationToken cancellationToken = default)
=> throw new NotImplementedException();
}
private static ISender CreateSender<T>(T? response) => new StubSender(response);
#endregion
#region Throw non-null scalar
[Test]
public async Task Throw_WithNonNullResponse_ReturnsResponse()
{
var sender = CreateSender<string>("hello");
var request = new StubRequest<string?>();
var result = await sender.GetOr(request).Throw(() => new InvalidOperationException());
Assert.That(result, Is.EqualTo("hello"));
}
#endregion
#region Throw null response
[Test]
public void Throw_WithNullResponse_ThrowsCustomException()
{
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
var ex = Assert.ThrowsAsync<InvalidOperationException>(
() => sender.GetOr(request).Throw(() => new InvalidOperationException("custom")));
Assert.That(ex!.Message, Is.EqualTo("custom"));
}
#endregion
#region Throw empty collection
[Test]
public void Throw_WithEmptyList_ThrowsCustomException()
{
var sender = CreateSender<List<string>>(new List<string>());
var request = new StubRequest<List<string>?>();
Assert.ThrowsAsync<ArgumentException>(
() => sender.GetOr(request).Throw(() => new ArgumentException("empty")));
}
#endregion
#region Throw non-empty collection
[Test]
public async Task Throw_WithNonEmptyList_ReturnsResponse()
{
var expected = new List<int> { 1, 2 };
var sender = CreateSender<List<int>>(expected);
var request = new StubRequest<List<int>?>();
var result = await sender.GetOr(request).Throw(() => new InvalidOperationException());
Assert.That(result, Is.EqualTo(expected));
}
#endregion
#region Throw string edge case (string implements IEnumerable)
[Test]
public async Task Throw_WithEmptyString_ReturnsEmptyString()
{
var sender = CreateSender<string>("");
var request = new StubRequest<string?>();
var result = await sender.GetOr(request).Throw(() => new InvalidOperationException("should not throw"));
Assert.That(result, Is.EqualTo(""));
}
#endregion
#region ThrowNotFound non-null scalar
[Test]
public async Task ThrowNotFound_WithNonNullResponse_ReturnsResponse()
{
var sender = CreateSender<string>("hello");
var request = new StubRequest<string?>();
var result = await sender.GetOr(request).ThrowNotFound();
Assert.That(result, Is.EqualTo("hello"));
}
[Test]
public async Task ThrowNotFound_WithExceptionMessage_AndNonNullResponse_ReturnsResponse()
{
var sender = CreateSender<int>(42);
var request = new StubRequest<int?>();
var result = await sender.GetOr(request).ThrowNotFound("not found");
Assert.That(result, Is.EqualTo(42));
}
#endregion
#region ThrowNotFound null response
[Test]
public void ThrowNotFound_WithNullResponse_ThrowsNotFoundException()
{
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
Assert.ThrowsAsync<NotFoundException>(() => sender.GetOr(request).ThrowNotFound());
}
[Test]
public void ThrowNotFound_WithNullResponse_AndCustomMessage_ContainsMessage()
{
const string message = "Entity not found";
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
var ex = Assert.ThrowsAsync<NotFoundException>(
() => sender.GetOr(request).ThrowNotFound(message));
Assert.That(ex!.Message, Does.Contain(message));
}
[Test]
public void ThrowNotFound_WithNullResponse_HasDefaultMessageWithTypeName()
{
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
var ex = Assert.ThrowsAsync<NotFoundException>(() => sender.GetOr(request).ThrowNotFound());
Assert.That(ex!.Message, Does.Contain(nameof(String)));
}
#endregion
#region ThrowNotFound empty collection
[Test]
public void ThrowNotFound_WithEmptyList_ThrowsNotFoundException()
{
var sender = CreateSender<List<string>>(new List<string>());
var request = new StubRequest<List<string>?>();
Assert.ThrowsAsync<NotFoundException>(() => sender.GetOr(request).ThrowNotFound());
}
[Test]
public void ThrowNotFound_WithEmptyArray_ThrowsNotFoundException()
{
var sender = CreateSender<int[]>(Array.Empty<int>());
var request = new StubRequest<int[]?>();
Assert.ThrowsAsync<NotFoundException>(() => sender.GetOr(request).ThrowNotFound());
}
[Test]
public void ThrowNotFound_WithEmptyCollection_AndCustomMessage_ContainsMessage()
{
const string message = "No items found";
var sender = CreateSender<List<int>>(new List<int>());
var request = new StubRequest<List<int>?>();
var ex = Assert.ThrowsAsync<NotFoundException>(
() => sender.GetOr(request).ThrowNotFound(message));
Assert.That(ex!.Message, Does.Contain(message));
}
#endregion
#region ThrowNotFound non-empty collection
[Test]
public async Task ThrowNotFound_WithNonEmptyList_ReturnsResponse()
{
var expected = new List<string> { "a", "b" };
var sender = CreateSender<List<string>>(expected);
var request = new StubRequest<List<string>?>();
var result = await sender.GetOr(request).ThrowNotFound();
Assert.That(result, Is.EqualTo(expected));
}
[Test]
public async Task ThrowNotFound_WithNonEmptyArray_ReturnsResponse()
{
var expected = new[] { 1, 2, 3 };
var sender = CreateSender<int[]>(expected);
var request = new StubRequest<int[]?>();
var result = await sender.GetOr(request).ThrowNotFound();
Assert.That(result, Is.EqualTo(expected));
}
#endregion
#region ThrowInvalidOperation null response
[Test]
public void ThrowInvalidOperation_WithNullResponse_ThrowsInvalidOperationException()
{
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
Assert.ThrowsAsync<InvalidOperationException>(
() => sender.GetOr(request).ThrowInvalidOperation());
}
[Test]
public void ThrowInvalidOperation_WithNullResponse_AndCustomMessage_ContainsMessage()
{
const string message = "Something went wrong";
var sender = CreateSender<string>(null);
var request = new StubRequest<string?>();
var ex = Assert.ThrowsAsync<InvalidOperationException>(
() => sender.GetOr(request).ThrowInvalidOperation(message));
Assert.That(ex!.Message, Does.Contain(message));
}
#endregion
#region CancellationToken
[Test]
public void Throw_WithCancelledToken_ThrowsOperationCanceledException()
{
var sender = CreateSender<string>("value");
var request = new StubRequest<string?>();
var cts = new CancellationTokenSource();
cts.Cancel();
Assert.ThrowsAsync<OperationCanceledException>(
() => sender.GetOr(request, cts.Token).Throw(() => new InvalidOperationException()));
}
[Test]
public void ThrowNotFound_WithCancelledToken_ThrowsOperationCanceledException()
{
var sender = CreateSender<string>("value");
var request = new StubRequest<string?>();
var cts = new CancellationTokenSource();
cts.Cancel();
Assert.ThrowsAsync<OperationCanceledException>(
() => sender.GetOr(request, cts.Token).ThrowNotFound());
}
#endregion
}