failure in sub workflow will terminate the parent workflow

Author: kfrajtak

src/WorkflowCore/Models/LifeCycleEvents/SubWorkflowLifeCycleEvent.cs

@@ -0,0 +1,7 @@
+namespace WorkflowCore.Models.LifeCycleEvents
+{
+    public class SubWorkflowLifeCycleEvent : LifeCycleEvent
+    {
+        
+    }
+}

src/WorkflowCore/Primitives/SubWorkflowStepBody.cs

@@ -18,8 +18,6 @@ public SubWorkflowStepBody(IScopeProvider scopeProvider)
 
         public override ExecutionResult Run(IStepExecutionContext context)
         {
-            var eventKey = context.ExecutionPointer.EventKey;
-
             var scope = _scopeProvider.CreateScope(context);
             var workflowController = scope.ServiceProvider.GetRequiredService<IWorkflowController>();
             var logger = scope.ServiceProvider.GetRequiredService<ILoggerFactory>().CreateLogger(
@@ -32,19 +30,24 @@ public override ExecutionResult Run(IStepExecutionContext context)
                 logger.LogDebug("Started sub workflow {Name} with id='{SubId}' from workflow {WorkflowDefinitionId} ({Id})", 
                     SubWorkflowId, result, context.Workflow.WorkflowDefinitionId, context.Workflow.Id);
 
-                logger.LogDebug("Workflow {Name} ({SubId}) is waiting for event WorkflowCompleted with key='{EventKey}'", 
+                logger.LogDebug("Workflow {Name} ({SubId}) is waiting for event SubWorkflowLifeCycleEvent with key='{EventKey}'", 
                     SubWorkflowId, result, result);
 
                 var effectiveDate = DateTime.MinValue;
-                return ExecutionResult.WaitForEvent(nameof(WorkflowCompleted), result, effectiveDate);
+                return ExecutionResult.WaitForEvent(nameof(SubWorkflowLifeCycleEvent), result, effectiveDate);
             }
 
             logger.LogDebug("Sub workflow {Name} ({SubId}) completed", SubWorkflowId, 
                 context.ExecutionPointer.EventKey);
 
             var persistenceProvider = scope.ServiceProvider.GetRequiredService<IPersistenceProvider>();
-
-            Result = persistenceProvider.GetWorkflowInstance(context.ExecutionPointer.EventKey).Result.Data;
+            var workflowInstance = persistenceProvider.GetWorkflowInstance(context.ExecutionPointer.EventKey).Result;
+            if (workflowInstance.Status == WorkflowStatus.Terminated)
+            {
+                throw new NotImplementedException(workflowInstance.Status.ToString());    
+            }
+            
+            Result = workflowInstance.Data;
             return ExecutionResult.Next();
         }
 

src/WorkflowCore/Services/WorkflowExecutor.cs

@@ -227,6 +227,12 @@ private async Task DetermineNextExecutionTime(WorkflowInstance workflow, Workflo
                 return;
             }
 
+            if (workflow.Status == WorkflowStatus.Terminated)
+            {
+                await OnTerminated(workflow, def);
+                return;
+            }
+
             foreach (var pointer in workflow.ExecutionPointers.Where(x => x.Active && (x.Children ?? new List<string>()).Count == 0))
             {
                 if (!pointer.SleepUntil.HasValue)
@@ -284,5 +290,28 @@ private async Task OnComplete(WorkflowInstance workflow, WorkflowDefinition def)
                 Version = workflow.Version
             });
         }
+        
+        private async Task OnTerminated(WorkflowInstance workflow, WorkflowDefinition def)
+        {
+            workflow.Status = WorkflowStatus.Terminated;
+            workflow.CompleteTime = _datetimeProvider.UtcNow;
+
+            using (var scope = _serviceProvider.CreateScope())
+            {
+                var middlewareRunner = scope.ServiceProvider.GetRequiredService<IWorkflowMiddlewareRunner>();
+                await middlewareRunner.RunPostMiddleware(workflow, def);
+            }
+            
+            _logger.LogDebug("Workflow {WorkflowDefinitionId} ({Id}) terminated", workflow.WorkflowDefinitionId, workflow.Id);
+
+            _publisher.PublishNotification(new WorkflowTerminated
+            {
+                EventTimeUtc = _datetimeProvider.UtcNow,
+                Reference = workflow.Reference,
+                WorkflowInstanceId = workflow.Id,
+                WorkflowDefinitionId = workflow.WorkflowDefinitionId,
+                Version = workflow.Version
+            });
+        }
     }
 }

src/WorkflowCore/Services/WorkflowHost.cs

@@ -165,10 +165,13 @@ public Task<bool> TerminateWorkflow(string workflowId)
 
         public void HandleLifeCycleEvent(LifeCycleEvent evt)
         {
-            if (evt is WorkflowCompleted completed)
+            switch (evt)
             {
-                _workflowController.PublishEvent(nameof(WorkflowCompleted), completed.WorkflowInstanceId,
-                    completed.Reference);
+                // publish the event as sub workflow lifecycle event
+                case WorkflowCompleted _:
+                case WorkflowTerminated _:
+                    _workflowController.PublishEvent(nameof(SubWorkflowLifeCycleEvent), evt.WorkflowInstanceId, evt.Reference);
+                    break;
             }
 
             OnLifeCycleEvent?.Invoke(evt);

src/providers/WorkflowCore.Persistence.EntityFramework/Services/EntityFrameworkPersistenceProvider.cs

@@ -100,6 +100,10 @@ public async Task<WorkflowInstance> GetWorkflowInstance(string Id, CancellationT
         {
             using (var db = ConstructDbContext())
             {
+                if (!Guid.TryParse(Id, out _))
+                {
+                    
+                }
                 var uid = new Guid(Id);
                 var raw = await db.Set<PersistedWorkflow>()
                     .Include(wf => wf.ExecutionPointers)

…ationTests/Scenarios/ApprovalScenario.cs …onTests/Scenarios/SubWorkflowScenario.cstest/WorkflowCore.IntegrationTests/Scenarios/ApprovalScenario.cs renamed to test/WorkflowCore.IntegrationTests/Scenarios/SubWorkflowScenario.cs test/WorkflowCore.IntegrationTests/Scenarios/ApprovalScenario.cs renamed to test/WorkflowCore.IntegrationTests/Scenarios/SubWorkflowScenario.cs

@@ -9,7 +9,7 @@
 
 namespace WorkflowCore.IntegrationTests.Scenarios;
 
-public class ApprovalScenario : WorkflowTest<ApprovalScenario.ParentWorkflow, ApprovalScenario.ApprovalInput>
+public class SubWorkflowScenario : WorkflowTest<SubWorkflowScenario.ParentWorkflow, SubWorkflowScenario.ApprovalInput>
 {
     public class ApprovalInput
     {
@@ -28,6 +28,7 @@ public class ParentWorkflow : IWorkflow<ApprovalInput>
         public void Build(IWorkflowBuilder<ApprovalInput> builder)
         {
             builder
+                .UseDefaultErrorBehavior(WorkflowErrorHandling.Terminate)
                 .StartWith(context => ExecutionResult.Next())
                 .SubWorkflow(nameof(ChildWorkflow))
                 .Output(i => i.Approved, step => ((ApprovalInput)step.Result).Approved)
@@ -48,6 +49,7 @@ public class ChildWorkflow : IWorkflow<ApprovalInput>
         public void Build(IWorkflowBuilder<ApprovalInput> builder)
         {
             builder
+                .UseDefaultErrorBehavior(WorkflowErrorHandling.Terminate)
                 .StartWith(context => ExecutionResult.Next())
                 .Parallel()
                 .Do(then
@@ -71,7 +73,7 @@ public void Build(IWorkflowBuilder<ApprovalInput> builder)
         }
     }
 
-    public ApprovalScenario()
+    public SubWorkflowScenario()
     {
         Setup();
     }
@@ -114,6 +116,34 @@ public void Scenario(bool approved)
         });
     }
 
+    [Fact]
+    public void Failure()
+    {
+        Host.Registry.RegisterWorkflow(new ChildWorkflow());
+        
+        var eventKey = Guid.NewGuid().ToString();
+        var workflowId = StartWorkflow(new ApprovalInput
+        {
+            Id = eventKey, 
+            TimeSpan = TimeSpan.FromMinutes(10)
+        });
+        
+        WaitForEventSubscription("Approved", workflowId, TimeSpan.FromSeconds(5));
+        UnhandledStepErrors.Should().BeEmpty();
+
+        Host.PublishEvent("Approved", workflowId, new
+        {
+            Approved = "string" 
+        });
+
+        WaitForWorkflowToComplete(workflowId, TimeSpan.FromSeconds(20));
+        
+        System.Threading.Thread.Sleep(2000);
+
+        UnhandledStepErrors.Should().NotBeEmpty();
+        GetStatus(workflowId).Should().Be(WorkflowStatus.Terminated);
+    }
+    
     [Fact]
     public void Timeout()
     {

…r/Scenarios/SqlServerApprovalScenario.cs …cenarios/SqlServerSubWorkflowScenario.cstest/WorkflowCore.Tests.SqlServer/Scenarios/SqlServerApprovalScenario.cs renamed to test/WorkflowCore.Tests.SqlServer/Scenarios/SqlServerSubWorkflowScenario.cs test/WorkflowCore.Tests.SqlServer/Scenarios/SqlServerApprovalScenario.cs renamed to test/WorkflowCore.Tests.SqlServer/Scenarios/SqlServerSubWorkflowScenario.cs

@@ -6,7 +6,7 @@
 namespace WorkflowCore.Tests.SqlServer.Scenarios
 {
     [Collection("SqlServer collection")]
-    public class SqlServerApprovalScenario() : ApprovalScenario()
+    public class SqlServerSubWorkflowScenario() : SubWorkflowScenario()
     {
         protected override void ConfigureServices(IServiceCollection services)
         {

…lite/Scenarios/SqliteApprovalScenario.cs …e/Scenarios/SqliteSubWorkflowScenario.cstest/WorkflowCore.Tests.Sqlite/Scenarios/SqliteApprovalScenario.cs renamed to test/WorkflowCore.Tests.Sqlite/Scenarios/SqliteSubWorkflowScenario.cs test/WorkflowCore.Tests.Sqlite/Scenarios/SqliteApprovalScenario.cs renamed to test/WorkflowCore.Tests.Sqlite/Scenarios/SqliteSubWorkflowScenario.cs

@@ -7,7 +7,7 @@
 namespace WorkflowCore.Tests.Sqlite.Scenarios
 {
     [Collection("Sqlite collection")]
-    public class SqliteApprovalScenario : ApprovalScenario
+    public class SqliteSubWorkflowScenario : SubWorkflowScenario
     {
         protected override void ConfigureServices(IServiceCollection services)
         {