Introduce labels and improve participant search functionality. (#963)

* Adds comprehensive participant labeling system

Introduces a robust participant labeling system to enhance participant management and categorization.

This includes:
- Implements `ParticipantLabel` domain entity with its own lifecycle, business rules, and events.
- Provides dedicated application services (commands, queries, and handlers) for adding, closing, and retrieving participant labels.
- Integrates `IParticipantLabelsCounter` for efficient tracking of active labels.
- Introduces an automated process to assign/remove "Veteran" labels based on participant bio submissions using integration events.
- Refactors existing `Label` management commands into separate command, handler, and validator files for improved modularity and maintainability.
- Updates participant list view to display assigned labels and allows filtering participants by specific labels.
- Adds a new database migration to create the `Participant.Label` table.
- Enhances unit test coverage for the new labeling features and refactored label commands.
- Configures RabbitMQ in Aspire for persistent data volumes.

This feature enables richer participant profiling and more precise filtering capabilities within the application.

* Extend search functionality.

- The search box is now clearable.
- If you enter two words, the search assumes you are looking for someone and only applies that search (specifically splitting the search term in two)
- Will now also filter for external identifiers so you can search for NOMIS and CRNs

* Fix naming conventions. Allow system to specify the creating user and remove unused ISoftDelete code.

* Adjust exports for better formatting.

- Add a column per label with a Y/N indicator
- Globally apply the autofilter on all exports that use the basic table dump

* Add ignore flag to smart enum property that is not serializable.

* Participants V2 optional from menu

Author: carlsixsmith-moj

Directory.Packages.props

@@ -58,6 +58,8 @@
     <PackageVersion Include="Microsoft.Extensions.Localization.Abstractions" Version="10.0.0" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="10.0.0" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
+    <PackageVersion Include="Moq" Version="4.20.72" />
+    <PackageVersion Include="Moq.Dapper" Version="1.0.7" />
     <PackageVersion Include="MudBlazor" Version="8.15.0" />
     <PackageVersion Include="NetArchTest.Rules" Version="1.3.2" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />

src/Application/Common/Extensions/QueryableExtensions.cs

@@ -37,5 +37,6 @@ public static async Task<PaginatedData<TResult>> ProjectToPaginatedDataAsync<T,
             .ProjectTo<TResult>(configuration)
             .ToListAsync(cancellationToken);
         return new PaginatedData<TResult>(data, count, pageNumber, pageSize);
-    }       
+    }
+
 }

src/Application/Common/Interfaces/IApplicationDbContext.cs

@@ -14,6 +14,7 @@
 using Cfo.Cats.Domain.Entities.ManagementInformation;
 using Cfo.Cats.Domain.Entities.PRIs;
 using Cfo.Cats.Domain.Labels;
+using Cfo.Cats.Domain.ParticipantLabels;
 
 namespace Cfo.Cats.Application.Common.Interfaces;
 
@@ -123,4 +124,6 @@ public interface IApplicationDbContext
     DbSet<ArchivedCase> ArchivedCases { get; }
     DbSet<ProviderFeedbackEnrolment> ProviderFeedbackEnrolments { get; }
     DbSet<ProviderFeedbackActivity> ProviderFeedbackActivities { get; }
+    
+    DbSet<ParticipantLabel> ParticipantLabels { get; }
 }

src/Application/DependencyInjection.cs

@@ -3,9 +3,11 @@
 using Cfo.Cats.Application.Features.Labels;
 using Cfo.Cats.Application.Features.ManagementInformation;
 using Cfo.Cats.Application.Features.ManagementInformation.Providers;
+using Cfo.Cats.Application.Features.ParticipantLabels;
 using Cfo.Cats.Application.Features.PerformanceManagement.Providers;
 using Cfo.Cats.Application.Pipeline;
 using Cfo.Cats.Domain.Labels;
+using Cfo.Cats.Domain.ParticipantLabels;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -70,6 +72,7 @@ public static IServiceCollection AddApplication(this IServiceCollection services
             .WithScopedLifetime());
 
         services.AddScoped<ILabelCounter, LabelCounter>();
+        services.AddScoped<IParticipantLabelsCounter, ParticipantLabelsCounter>();
 
         return services;
     }

src/Application/Features/Bios/EventHandlers/PublishBioSubmittedEventHandler.cs

@@ -0,0 +1,11 @@
+using Cfo.Cats.Application.Features.Bios.IntegrationEvents;
+using Cfo.Cats.Application.Outbox;
+using Cfo.Cats.Domain.Events;
+
+namespace Cfo.Cats.Application.Features.Bios.EventHandlers;
+
+public class PublishBioSubmittedEventHandler(IUnitOfWork unitOfWork) : INotificationHandler<BioSubmittedDomainEvent>
+{
+    public async Task Handle(BioSubmittedDomainEvent notification, CancellationToken cancellationToken) 
+    => await unitOfWork.DbContext.InsertOutboxMessage(new BioSubmittedIntegrationEvent(notification.Item.Id));
+}

src/Application/Features/Bios/IntegrationEvents/BioSubmittedIntegrationEvent.cs

@@ -0,0 +1,5 @@
+namespace Cfo.Cats.Application.Features.Bios.IntegrationEvents;
+
+public record BioSubmittedIntegrationEvent(Guid BioId)
+{
+}

src/Application/Features/Documents/IntegrationEventHandlers/DocumentExportParticipantsIntegrationEventConsumer.cs

@@ -11,7 +11,6 @@ public class DocumentExportParticipantsIntegrationEventConsumer(
     IUnitOfWork unitOfWork,
     IExcelService excelService,
     IUploadService uploadService,
-    IMapper mapper,
     IDomainEventDispatcher domainEventDispatcher,
     ILogger<DocumentExportParticipantsIntegrationEventConsumer> logger) : IHandleMessages<ExportDocumentIntegrationEvent>
 {
@@ -39,21 +38,38 @@ public async Task Handle(ExportDocumentIntegrationEvent context)
             request.PageSize = int.MaxValue;
 
             // Hack: call handler directly (skips Authorization pipeline, as we're outside of the HttpContext).
-            var data = await new ParticipantsWithPagination.Handler(unitOfWork, mapper).Handle(request!, CancellationToken.None);
+            var data = await new ParticipantsWithPagination.Handler(unitOfWork).Handle(request!, CancellationToken.None);
 
+            var dataToColumnMapper = new Dictionary<string, Func<ParticipantPaginationDto, object?>>
+            {
+                { "Id", item => item.Id },
+                { "Participant", item => item.ParticipantName },
+                { "Status", item => item.EnrolmentStatus },
+                { "Consent", item => item.ConsentStatus },
+                { "Location", item => item.CurrentLocation.Name },
+                { "Enrolled At", item => item.EnrolmentLocation?.Name },
+                { "Assignee", item => item.Owner },
+                { "Risk Due", item => item.RiskDue },
+                { "Risk Due Reason", item => item.RiskDueReason.Name },
+            };
+            
+            if(!data.Succeeded || data?.Data is null)
+            {
+                throw new ApplicationException("Failed to fetch participant data");
+            }
+            
+            // get a list of labels from all the participants
+            var allLabels = data.Data.Items.SelectMany(p => p.Labels)
+                .GroupBy(label => label.Name)
+                .Select(labelGroup => labelGroup.Key);
+
+            foreach (var label in allLabels)
+            {
+                dataToColumnMapper.Add(label, dto => dto.Labels.Any(l => l.Name == label) ? "Y" : "N");
+            }
+            
             var results = await excelService.ExportAsync(data?.Data?.Items ?? [],
-                new Dictionary<string, Func<ParticipantPaginationDto, object?>>
-                {
-                    { "Id", item => item.Id },
-                    { "Participant", item => item.ParticipantName },
-                    { "Status", item => item.EnrolmentStatus },
-                    { "Consent", item => item.ConsentStatus },
-                    { "Location", item => item.CurrentLocation.Name },
-                    { "Enrolled At", item => item.EnrolmentLocation?.Name },
-                    { "Assignee", item => item.Owner },
-                    { "Risk Due", item => item.RiskDue },
-                    { "Risk Due Reason", item => item.RiskDueReason.Name }
-                }
+                dataToColumnMapper
             );
 
             var uploadRequest = new UploadRequest(document.Title!, UploadType.Document, results);

src/Application/Features/Labels/Commands/AddLabel.cs

@@ -0,0 +1,32 @@
+using System.ComponentModel.DataAnnotations;
+using Cfo.Cats.Application.Common.Security;
+using Cfo.Cats.Application.SecurityConstants;
+using Cfo.Cats.Domain.Labels;
+
+namespace Cfo.Cats.Application.Features.Labels.Commands;
+
+[RequestAuthorize(Policy = SecurityPolicies.ManageLabels)]
+public class AddLabelCommand : IRequest<Result>
+{
+    [Display(Name = "Name", Description = "The display name of the label. Must be unique within a contract")]
+    public required string Name { get; set; }
+
+    [Display(Name="Description", Description = "A textual description of the label. Will appear as a tool tip")]
+    public required string Description { get; set; }
+
+    [Display(Name = "Scope", Description = "The scope for adding a label (system labels are not available for user selection)")]
+    public required LabelScope Scope { get; set; }
+
+    [Display(Name="Colour", Description = "The colour for the label. More pronounced on Filled labels.")]
+    public required AppColour Colour { get; set; }
+    
+    [Display(Name = "Variant", Description = "Label display mode (Text/Outlined/Filled)")]
+    public required AppVariant Variant { get; set; }
+
+    [Display(Name ="Icon", Description = "The icon to display (or None)")]
+    public AppIcon AppIcon { get; set; }
+
+    [Display(Name="Contract", Description = "Option contract to limit user applicability and visibility")]
+    public string? ContractId { get; set; }
+    
+}

src/Application/Features/Labels/Commands/AddLabel/AddLabelCommand.cs

@@ -0,0 +1,25 @@
+using Cfo.Cats.Domain.Labels;
+
+namespace Cfo.Cats.Application.Features.Labels.Commands;
+
+public class AddLabelCommandHandler(
+        ILabelRepository repository, 
+        ILabelCounter labelCounter) : IRequestHandler<AddLabelCommand, Result>
+{
+    public async Task<Result> Handle(
+        AddLabelCommand request, 
+        CancellationToken cancellationToken)
+    {
+        var l = Label.Create(
+            request.Name, 
+            request.Description,
+            request.Scope, 
+            request.Colour, 
+            request.Variant, 
+            request.AppIcon,
+            request.ContractId, 
+            labelCounter);
+        await repository.AddAsync(l);
+        return Result.Success();
+    }
+}