Refactor access code request logic with MediatR
Encapsulated the access code request logic in a new `SendAccessCodeCommand` using MediatR. Introduced a `SendAccessCodeResult` enum to standardize outcomes. Refactored `AuthController` to delegate access code handling to the command, simplifying the controller and reducing dependencies. Updated `AuthService` to map HTTP responses to `SendAccessCodeResult`. Improved error handling and edge case management in `SendAccessCodeCommandHandler`. Centralized history recording and notification logic in the command handler for better maintainability and separation of concerns.
This commit is contained in:
@@ -0,0 +1,101 @@
|
||||
using DigitalData.Core.Exceptions;
|
||||
using EnvelopeGenerator.Application.Common.Dto.EnvelopeReceiver;
|
||||
using EnvelopeGenerator.Application.Common.Interfaces.Services;
|
||||
using EnvelopeGenerator.Application.Common.Interfaces.Services.Notification;
|
||||
using EnvelopeGenerator.Application.EnvelopeReceivers.Queries;
|
||||
using EnvelopeGenerator.Domain.Constants;
|
||||
using EnvelopeGenerator.Domain.Exceptions;
|
||||
using MediatR;
|
||||
|
||||
namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
|
||||
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
/// <param name="Key"></param>
|
||||
public record SendAccessCodeCommand(string Key) : IRequest<SendAccessCodeResult>
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Business result of an access-code request.
|
||||
/// </summary>
|
||||
public enum SendAccessCodeResult
|
||||
{
|
||||
/// <summary>
|
||||
/// Access code sent successfully. HTTP: 200 OK.
|
||||
/// </summary>
|
||||
Sent,
|
||||
|
||||
/// <summary>
|
||||
/// Receiver has already signed this envelope; requesting a code is no longer applicable. HTTP: 409 Conflict.
|
||||
/// </summary>
|
||||
AlreadySigned,
|
||||
|
||||
/// <summary>
|
||||
/// Envelope does not require an access code. HTTP: 200 OK (or 204 No Content).
|
||||
/// </summary>
|
||||
NoAccessCodeRequired,
|
||||
|
||||
/// <summary>
|
||||
/// Access code was already requested and the request limit/rule blocks another send. HTTP: 429 Too Many Requests.
|
||||
/// </summary>
|
||||
RequestLimitExceeded
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
public class SendAccessCodeCommandHandler(IMediator Sender, IEnvelopeHistoryService HistoryService, IEnvelopeNotificationService NtfService) : IRequestHandler<SendAccessCodeCommand, SendAccessCodeResult>
|
||||
{
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
/// <param name="request"></param>
|
||||
/// <param name="cancel"></param>
|
||||
/// <returns></returns>
|
||||
public async Task<SendAccessCodeResult> Handle(SendAccessCodeCommand request, CancellationToken cancel)
|
||||
{
|
||||
// read envelope receiver
|
||||
var ers = (await Sender.Send(new ReadEnvelopeReceiverQuery
|
||||
{
|
||||
Key = request.Key,
|
||||
}, cancel));
|
||||
|
||||
if (ers.SingleOrDefault() is not EnvelopeReceiverDto er || er.Envelope is null || er.Receiver is null)
|
||||
throw new NotFoundException($"Envelope receiver with key '{request.Key}' not found.");
|
||||
|
||||
if (!er.Envelope.UseAccessCode)
|
||||
return SendAccessCodeResult.NoAccessCodeRequired;
|
||||
|
||||
var userReference = er.Receiver.EmailAddress;
|
||||
|
||||
if (await HistoryService.IsSigned(er.EnvelopeId, userReference))
|
||||
return SendAccessCodeResult.AlreadySigned;
|
||||
|
||||
var accessCodeAlreadyRequested = await HistoryService.AccessCodeAlreadyRequested(er.EnvelopeId, userReference);
|
||||
if (accessCodeAlreadyRequested)
|
||||
return SendAccessCodeResult.RequestLimitExceeded;
|
||||
|
||||
var historyResult = await HistoryService.RecordAsync(er.EnvelopeId, userReference, EnvelopeStatus.AccessCodeRequested);
|
||||
if (historyResult.IsFailed)
|
||||
{
|
||||
throw new ApplicationException($"Failed to record AccessCodeRequested history for envelope {er.EnvelopeId} and receiver {userReference}.");
|
||||
}
|
||||
|
||||
if(er.AccessCode is null)
|
||||
throw new DataIntegrityException($"Access code is null for envelope receiver with key '{request.Key}' although use-access-code is true.");
|
||||
|
||||
await NtfService.Notify(er.Receiver.EmailAddress, new DocumentAccessCodeReceivedNotification()
|
||||
{
|
||||
DocumentAccessCode = er.AccessCode,
|
||||
DocumentTitle = er.Envelope.Title,
|
||||
NameReceiver = er.Name ?? string.Empty,
|
||||
IsReadAndConfirm = er.Envelope.Type == EnvelopeType.ReadAndConfirm,
|
||||
NameSender = er.Envelope.User!.Username,
|
||||
}, cancel);
|
||||
|
||||
return SendAccessCodeResult.Sent;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user