Fix/dn 3864 parallel step conditions (#191)

* DN-3864 Updated StepVersionService for parallel child steps

* DN-3864 Made step versions be based on previous event history

* DN-3864 Unit tests for step versions based on event history

* DN-3864 Added icon to Assessment step for RMSS

* DN-3864 Added Condition 'isMet' overload for event ids

* DN-3864 WorkflowInstanceService refactor for history

- Added WorkflowInstanceHistory which fetches the instance journal and eventLogs.
- Updated StepVersion flow to use journal and eventLogs.
- Added more Unit Tests for StepVersion cases.

* DN-3864 Cleaned up WorkflowInstanceService

* DN-3864 Removed unused GetEventLogEntriesForInstanceUntil function

* DN-3864 Updated silent return to NotSupportedException.

* DN-3864 fix: unit tests

* DN-3864 Refactored the StepVersionService to Single or Multi event versioning

* DN-3864 Moved the step version 'skip' and 'sort' to Controller and Dto

* DN-3864 Removed deprecated GetStepVersions

* DN-3864 Fixed some unit tests after merging

---------

Co-authored-by: Michel Roos <m.roos3@uva.nl>
Co-authored-by: Gerrit Oomens <g.oomens@uva.nl>

Author: 3 people

UvA.Workflow.Api/Steps/StepsController.cs

@@ -1,6 +1,7 @@
 using UvA.Workflow.Api.Submissions.Dtos;
 using UvA.Workflow.Api.Users.Dtos;
 using UvA.Workflow.Api.WorkflowDefinitions.Dtos;
+using UvA.Workflow.Events;
 using UvA.Workflow.Submissions;
 using UvA.Workflow.Versioning;
 using UvA.Workflow.WorkflowModel;
@@ -26,8 +27,6 @@ public async Task<WorkflowInstanceDto> Create(WorkflowInstance instance, Cancell
     {
         var actions = await instanceService.GetAllowedActions(instance, ct);
         var submissions = await instanceService.GetAllowedSubmissions(instance, ct);
-        var allowedForms = (await rightsService.GetAllowedActions(instance, RoleAction.View))
-            .SelectMany(a => a.AllForms).ToArray();
         var workflowDefinition = modelService.WorkflowDefinitions[instance.WorkflowDefinition];
         var permissions = await rightsService.GetAllowedActions(instance, RoleAction.ViewAdminTools, RoleAction.Edit);
         // Both admin-tool and impersonation visibility are evaluated against the real user (ignoring any
@@ -50,7 +49,11 @@ await instanceService.Enrich(workflowDefinition, [context],
             workflowDefinition.Steps.SelectMany(f => f.Lookups).Concat(relatedUserLookups).Concat(resourceLookups), ct);
 
         // Fetch versions for all steps
-        var stepVersionsMap = await GetStepVersionsMap(instance, workflowDefinition.AllSteps, ct);
+        var instanceHistory = await workflowInstanceService.GetInstanceHistory(instance.Id, ct);
+        var stepVersionsMap = GetStepVersionsMap(instance, workflowDefinition.AllSteps, instanceHistory.EventLogs);
+        var steps = await Task.WhenAll(workflowDefinition.Steps
+            .Where(s => s.Condition.IsMet(context))
+            .Select(s => CreateStepDto(s, instance, stepVersionsMap, instanceHistory, context, ct)));
 
         var editActions = permissions.Where(a => a.Type == RoleAction.Edit).ToArray();
         var canEditByProperty = rightsService.CanEditProperties(
@@ -72,10 +75,7 @@ await instanceService.Enrich(workflowDefinition, [context],
             instance.ParentId,
             actions.Select(ActionDto.Create).ToArray(),
             CreateFields(workflowDefinition, instance.Id, ct).Result ?? [],
-            workflowDefinition.Steps
-                .Where(s => s.Condition.IsMet(context))
-                .Select(s => CreateStepDto(s, instance, stepVersionsMap, context, allowedForms))
-                .ToArray(),
+            steps,
             submissions
                 .Select(s => submissionDtoFactory.Create(instance, s.Form, s.SubmissionState, s.QuestionStatus,
                     permissions.Where(p => p.MatchesForm(s.Form.Name)).Select(p => p.Type).ToArray()))
@@ -115,20 +115,21 @@ await instanceService.Enrich(workflowDefinition, [context],
     }
 
     /// <summary>
-    /// Fetches versions for all steps and returns a dictionary keyed by step name
+    /// Creates versions for all steps from a preloaded instance-wide event log.
     /// </summary>
-    private async Task<Dictionary<string, List<StepVersion>>> GetStepVersionsMap(
+    private Dictionary<string, List<StepVersion>> GetStepVersionsMap(
         WorkflowInstance instance,
         IEnumerable<Step> steps,
-        CancellationToken ct)
+        IEnumerable<InstanceEventLogEntry> eventLogs)
     {
+        var eventLogList = eventLogs.ToList();
         var stepVersionsMap = new Dictionary<string, List<StepVersion>>();
 
         foreach (var step in steps)
         {
             try
             {
-                var versions = await stepVersionService.GetStepVersions(instance, step.Name, ct);
+                var versions = stepVersionService.GetStepVersions(instance, step, eventLogList);
                 if (versions.Any())
                 {
                     stepVersionsMap[step.Name] = versions;
@@ -147,15 +148,31 @@ private async Task<Dictionary<string, List<StepVersion>>> GetStepVersionsMap(
     /// <summary>
     /// Creates a StepDto with versions from the map, recursively handling child steps
     /// </summary>
-    private StepDto CreateStepDto(
+    private async Task<StepDto> CreateStepDto(
         Step step,
         WorkflowInstance instance,
         Dictionary<string, List<StepVersion>> stepVersionsMap,
+        WorkflowInstanceHistory instanceHistory,
         ObjectContext context,
-        string[] allowedForms)
+        CancellationToken ct)
     {
         var workflowDef = modelService.WorkflowDefinitions[instance.WorkflowDefinition];
-        var versions = stepVersionsMap.GetValueOrDefault(step.Name);
+
+        // The newest version is the step's live state, already rendered as the current submission.
+        var versions = stepVersionsMap.GetValueOrDefault(step.Name)
+            ?.OrderByDescending(version => version.SubmittedAt)
+            .Skip(step.HasEnded(context) ? 1 : 0);
+
+        var children = step.Children.Length != 0
+            ? await Task.WhenAll(step.Children
+                .Where(s => s.Condition.IsMet(context))
+                .Select(s => CreateStepDto(s, instance, stepVersionsMap, instanceHistory, context, ct)))
+            : null;
+        var versionDtos = versions != null
+            ? await Task.WhenAll(versions
+                .OrderByDescending(version => version.SubmittedAt)
+                .Select(version => CreateStepVersionDto(version, instance, instanceHistory, ct)))
+            : null;
 
         return new StepDto(
             step.Name,
@@ -164,32 +181,31 @@ private StepDto CreateStepDto(
             step.EndEvent,
             step.GetEndDate(instance, workflowDef),
             step.GetDeadline(instance, modelService),
-            step.Children.Length != 0
-                ? step.Children
-                    .Where(s => s.Condition.IsMet(context))
-                    .Select(s => CreateStepDto(s, instance, stepVersionsMap, context, allowedForms))
-                    .ToArray()
-                : null,
+            children,
             stepHeaderStatusResolver.Resolve(step, instance),
             step.ResultsType,
             step.HierarchyMode,
-            versions?.Select(v => CreateStepVersionDto(v, instance, allowedForms)).ToList()
+            versionDtos?.ToList()
         );
     }
 
     /// <summary>
     /// Creates a StepVersionDto with properly constructed SubmissionDtos for all events in the version
     /// </summary>
-    private StepVersionDto CreateStepVersionDto(StepVersion stepVersion, WorkflowInstance instance,
-        string[] allowedForms)
+    private async Task<StepVersionDto> CreateStepVersionDto(
+        StepVersion stepVersion,
+        WorkflowInstance instance,
+        WorkflowInstanceHistory instanceHistory,
+        CancellationToken ct)
     {
         try
         {
             var submissions = new List<SubmissionDto>();
 
             // Get the instance at the version timestamp
             var instanceAtVersion = workflowInstanceService
-                .GetAsOfTimestamp(instance.Id, stepVersion.SubmittedAt, CancellationToken.None).Result;
+                .GetAsOfTimestamp(instance, stepVersion.SubmittedAt, instanceHistory);
+            var allowedViewActions = await rightsService.GetAllowedActions(instanceAtVersion, RoleAction.View);
 
             // Create a submission for each event in the version
             foreach (var eventId in stepVersion.EventIds)
@@ -202,7 +218,7 @@ private StepVersionDto CreateStepVersionDto(StepVersion stepVersion, WorkflowIns
                     continue;
                 }
 
-                if (!allowedForms.Contains(form.Name))
+                if (!allowedViewActions.Any(action => action.MatchesForm(form.Name)))
                     continue;
 
                 // Get question status with all fields visible (historical view)

UvA.Workflow.Api/WorkflowInstances/Dtos/WorkflowInstanceDtoFactory.cs

@@ -131,4 +131,19 @@ public async Task<List<InstanceEventLogEntry>> GetEventLogEntriesForInstance(
             .SortBy(e => e.Timestamp)
             .ToListAsync(ct);
     }
+
+    /// <summary>
+    /// Gets all event log entries for an instance.
+    /// </summary>
+    public async Task<List<InstanceEventLogEntry>> GetEventLogEntriesForInstance(
+        string instanceId,
+        CancellationToken ct)
+    {
+        var filter = Builders<InstanceEventLogEntry>.Filter.Eq(e => e.WorkflowInstanceId, instanceId);
+
+        return await _eventLogCollection
+            .Find(filter)
+            .SortBy(e => e.Timestamp)
+            .ToListAsync(ct);
+    }
 }

UvA.Workflow.Persistence.Mongo/InstanceEventRepository.cs

@@ -35,7 +35,7 @@ public ActionsControllerTests() : base()
                 submissionDtoFactory,
                 _workflowInstanceRepoMock.Object,
                 _rightsService,
-                new StepVersionService(_modelService, _eventRepoMock.Object),
+                new StepVersionService(),
                 new StepHeaderStatusResolver(_modelService),
                 _workflowInstanceService,
                 _loggerFactory.CreateLogger<WorkflowInstanceDtoFactory>());

UvA.Workflow.Tests/Controllers/ActionsControllerTests.cs

@@ -11,7 +11,6 @@
 using UvA.Workflow.Api.WorkflowInstances.Dtos;
 using UvA.Workflow.Infrastructure;
 using UvA.Workflow.Organizations;
-using UvA.Workflow.Persistence;
 using UvA.Workflow.Submissions;
 using UvA.Workflow.Tests.Controllers.Helpers;
 using UvA.Workflow.Tests.Helpers;
@@ -35,7 +34,7 @@ public AnswersControllerTests() : base()
     {
         _artifactTokenService = new ArtifactTokenService(UnitTestsHelpers.TestS3Config);
         _workflowInstanceService = new WorkflowInstanceService(_modelService, _workflowInstanceRepoMock.Object,
-            _instanceJournalServiceMock.Object, _userServiceMock.Object);
+            _instanceJournalServiceMock.Object, _eventRepoMock.Object, _userServiceMock.Object);
         _submissionDtoFactory =
             new SubmissionDtoFactory(_artifactTokenService, _modelService);
         _workflowInstanceDtoFactory =
@@ -45,7 +44,7 @@ public AnswersControllerTests() : base()
                 _submissionDtoFactory,
                 _workflowInstanceRepoMock.Object,
                 _rightsService,
-                new StepVersionService(_modelService, _eventRepoMock.Object),
+                new StepVersionService(),
                 new StepHeaderStatusResolver(_modelService),
                 _workflowInstanceService,
                 _loggerFactory.CreateLogger<WorkflowInstanceDtoFactory>());