Replace generic exception in PRI workflow to give better user messages on expected failures. (#952)

Author: carlsixsmith-moj

src/Application/Features/PRIs/EventHandlers/PreventCompletionOfTaskWithoutRelease.cs

@@ -1,9 +1,11 @@
 using Cfo.Cats.Domain.Events;
-
+using Cfo.Cats.Domain.Common.Exceptions;
 namespace Cfo.Cats.Application.Features.PRIs.EventHandlers;
 
 internal class PreventCompletionOfTaskWithoutRelease(IUnitOfWork unitOfWork) : INotificationHandler<ObjectiveTaskCompletedDomainEvent>
 {
+    
+    // TODO: Replace this with a business rule?
     public async Task Handle(ObjectiveTaskCompletedDomainEvent notification, CancellationToken cancellationToken)
     {
         if (notification.Item is { IsMandatory: true, Index: 2 } && notification.Item.CompletedStatus == CompletionStatus.Done)
@@ -20,7 +22,7 @@ public async Task Handle(ObjectiveTaskCompletedDomainEvent notification, Cancell
 
             if (pri.ActualReleaseDate is null)
             {
-                throw new ApplicationException("Cannot accept this task as the actual release date is missing from the PRI");
+                throw new PriMissingActualReleaseDateException();
             }
 
             // Has the participant been in the expected release region after the PRI was created?
@@ -32,7 +34,7 @@ public async Task Handle(ObjectiveTaskCompletedDomainEvent notification, Cancell
 
             if (hasBeenReleasedToLocation is false)
             {
-                throw new ApplicationException("Cannot accept this task as notice of the participants release to the expected release region has not yet been received.");
+                throw new PriNeverBeenInLocationException();
             }
         }
     }

src/Domain/Common/Exceptions/PriMissingActualReleaseDateException.cs

@@ -0,0 +1,14 @@
+namespace Cfo.Cats.Domain.Common.Exceptions;
+
+public class PriMissingActualReleaseDateException : DomainException
+{
+    /// <summary>
+    /// Exception that is raised if an attempt is made to close a PRI objective
+    /// when the actual release date has not been set.
+    /// </summary>
+    public PriMissingActualReleaseDateException()
+        : base("Task cannot be completed until the actual release date is set.")
+    {
+        
+    }
+}

src/Domain/Common/Exceptions/PriNeverBeenInLocationException.cs

@@ -0,0 +1,15 @@
+namespace Cfo.Cats.Domain.Common.Exceptions;
+
+public class PriNeverBeenInLocationException : DomainException
+{
+    /// <summary>
+    /// Exception that is raised if an attempt is made to close a PRI objective
+    /// when the participant has not been recorded as being in the specified release
+    /// region.
+    /// </summary>
+    public PriNeverBeenInLocationException()
+        : base("Task cannot be completed as notice of the participant's transfer to the expected release region has not yet been received.")
+    {
+        
+    }
+}