Add support for showing Processes in Change History (#2651)

We're moving to a new way of recording data changes - processes. This
adds support for showing these types of changes in the Change History
UI. Process-specific views will follow later.

Author: gunndabad

TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Mappings/ProcessEventMapping.cs

@@ -15,7 +15,7 @@ public void Configure(EntityTypeBuilder<ProcessEvent> builder)
             .HasConversion(
                 v => JsonSerializer.Serialize(v, typeof(IEvent), IEvent.SerializerOptions),
                 v => JsonSerializer.Deserialize<IEvent>(v, IEvent.SerializerOptions)!);
-        builder.HasOne<Process>().WithMany(a => a.Events).HasForeignKey(ae => ae.ProcessId);
+        builder.HasOne<Process>().WithMany(a => a.Events).HasForeignKey(ae => ae.ProcessId).HasConstraintName("fk_process_events_process_process_id");
         builder.HasIndex(e => new { e.PersonIds, e.EventName }).HasMethod("GIN").IsCreatedConcurrently();
         builder.HasIndex(e => e.ProcessId).IsCreatedConcurrently();
     }

TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Mappings/ProcessMapping.cs

@@ -8,7 +8,7 @@ public class ProcessMapping : IEntityTypeConfiguration<Process>
     public void Configure(EntityTypeBuilder<Process> builder)
     {
         builder.ToTable("processes");
-        builder.HasOne<User>().WithMany().HasForeignKey(p => p.UserId);
+        builder.HasOne(p => p.User).WithMany().HasForeignKey(p => p.UserId);
         builder.HasIndex(a => a.ProcessType);
         builder.HasIndex(a => a.PersonIds).HasMethod("GIN");
     }

TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Migrations/TrsDbContextModelSnapshot.cs

@@ -4562,7 +4562,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                         .HasColumnType("text")
                         .HasColumnName("dqt_user_name");
 
-                    b.PrimitiveCollection<HashSet<Guid>>("PersonIds")
+                    b.PrimitiveCollection<List<Guid>>("PersonIds")
                         .IsRequired()
                         .HasColumnType("uuid[]")
                         .HasColumnName("person_ids");
@@ -20990,10 +20990,12 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
             modelBuilder.Entity("TeachingRecordSystem.Core.DataStore.Postgres.Models.Process", b =>
                 {
-                    b.HasOne("TeachingRecordSystem.Core.DataStore.Postgres.Models.User", null)
+                    b.HasOne("TeachingRecordSystem.Core.DataStore.Postgres.Models.UserBase", "User")
                         .WithMany()
                         .HasForeignKey("UserId")
                         .HasConstraintName("fk_processes_users_user_id");
+
+                    b.Navigation("User");
                 });
 
             modelBuilder.Entity("TeachingRecordSystem.Core.DataStore.Postgres.Models.ProcessEvent", b =>

TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Models/Process.cs

@@ -6,8 +6,9 @@ public class Process
     public required ProcessType ProcessType { get; init; }
     public required DateTime Created { get; init; }
     public required Guid? UserId { get; init; }
+    public UserBase? User { get; }
     public required Guid? DqtUserId { get; init; }
     public required string? DqtUserName { get; init; }
     public ICollection<ProcessEvent>? Events { get; }
-    public required HashSet<Guid> PersonIds { get; init; }
+    public required List<Guid> PersonIds { get; init; }
 }

TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/TrsDbContext.cs

@@ -136,6 +136,8 @@ public static TrsDbContext Create(string connectionString, int? commandTimeout =
 
     public DbSet<TrnRange> TrnRanges => Set<TrnRange>();
 
+    public DbSet<Process> Processes => Set<Process>();
+
     public static void ConfigureOptions(DbContextOptionsBuilder optionsBuilder, string? connectionString = null, int? commandTimeout = null)
     {
         Action<NpgsqlDbContextOptionsBuilder> configureOptions = o => o.CommandTimeout(commandTimeout);

TeachingRecordSystem/src/TeachingRecordSystem.Core/IEventPublisher.cs

@@ -18,7 +18,7 @@ public async Task PublishEventAsync(IEvent @event, ProcessContext processContext
             dbContext.Set<Process>().Add(processContext.Process);
         }
 
-        @event.PersonIds.ForEach(e => processContext.Process.PersonIds.Add(e));
+        @event.PersonIds.Except(processContext.Process.PersonIds).ForEach(e => processContext.Process.PersonIds.Add(e));
 
         var processEvent = new ProcessEvent
         {

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/PersonDetail/ChangeHistory.cshtml

@@ -1,5 +1,6 @@
 @page "/persons/{personId}/change-history"
 @using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Events
+@using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Processes
 @model TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.ChangeHistoryModel
 @{
     Layout = "Layout";
@@ -23,6 +24,7 @@ else
             var viewName = timelineItem.ItemType switch
             {
                 TimelineItemType.Event => $"./Timeline/Events/{((TimelineEvent)timelineItem.ItemModel).Event.GetEventName()}.cshtml",
+                TimelineItemType.Process => $"./Timeline/Processes/{((TimelineProcess)timelineItem.ItemModel).Process.ProcessType.ToString()}.cshtml",
                 _ => $"./Timeline/{timelineItem.ItemType}.cshtml"
             };
 

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/PersonDetail/ChangeHistory.cshtml.cs

@@ -2,10 +2,13 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.RazorPages;
 using TeachingRecordSystem.Core.DataStore.Postgres;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.Core.Events.Legacy;
 using TeachingRecordSystem.SupportUi.Infrastructure.Security;
 using TeachingRecordSystem.SupportUi.Infrastructure.Security.Requirements;
+using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline;
 using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Events;
+using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Processes;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail;
 
@@ -144,7 +147,15 @@ e.person_ids @> ARRAY[{PersonId}]
                 """)
             .ToListAsync();
 
-        var allResults = eventsWithUser.Select(MapTimelineEvent).ToArray();
+        var processes = await dbContext.Processes
+            .Where(p => p.PersonIds.Contains(PersonId))
+            .Include(p => p.User)
+            .Include(p => p.Events).AsSplitQuery()
+            .ToListAsync();
+
+        var allResults = eventsWithUser.Select(MapTimelineEvent)
+            .Concat(processes.Select(MapTimelineProcess))
+            .ToArray();
 
         TimelineItems = allResults
             .OrderByDescending(i => i.Timestamp)
@@ -187,6 +198,13 @@ private TimelineItem MapTimelineEvent(EventWithUser eventWithUser)
         return (TimelineItem)Activator.CreateInstance(timelineItemType, TimelineItemType.Event, PersonId, timelineEvent.Event.CreatedUtc.ToGmt(), timelineEvent)!;
     }
 
+    private TimelineItem MapTimelineProcess(Process process) =>
+        new TimelineItem<TimelineProcess>(
+            TimelineItemType.Process,
+            PersonId,
+            process.Created.ToGmt(),
+            new TimelineProcess(process, new RaisedByUserInfo { Name = process.DqtUserName ?? process.User?.Name! }));
+
     /// <summary>
     /// Flattened out record to allow Event, TRS User and DQT User to be returned in a single SQL query
     /// </summary>

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/PersonDetail/Timeline/Processes/TimelineProcess.cs

@@ -0,0 +1,17 @@
+using System.Diagnostics.CodeAnalysis;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
+
+namespace TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Processes;
+
+public record TimelineProcess(Process Process, RaisedByUserInfo RaisedByUser)
+{
+    public bool ContainsEvent<T>() where T : IEvent => Process.Events!.Select(pe => pe.Payload).OfType<T>().Any();
+
+    public T GetEvent<T>() where T : IEvent => Process.Events!.Select(pe => pe.Payload).OfType<T>().Single();
+
+    public bool TryGetEvent<T>([NotNullWhen(true)] out T? @event) where T : IEvent
+    {
+        @event = Process.Events!.Select(pe => pe.Payload).OfType<T>().SingleOrDefault();
+        return @event is not null;
+    }
+}

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/PersonDetail/Timeline/Events/RaisedByUserInfo.cs renamed to TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/PersonDetail/Timeline/RaisedByUserInfo.cs

@@ -1,4 +1,4 @@
-namespace TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline.Events;
+namespace TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.Timeline;
 
 public record RaisedByUserInfo
 {