Merge pull request #710 from UltimateSoftware/feature/ScopedMiddleware

Feature - Scoped Middleware

Author: danielgerlag

src/WorkflowCore/ServiceCollectionExtensions.cs

@@ -51,10 +51,10 @@ public static IServiceCollection AddWorkflow(this IServiceCollection services, A
             services.AddSingleton<IGreyList, GreyList>();
             services.AddSingleton<IWorkflowController, WorkflowController>();
             services.AddSingleton<IActivityController, ActivityController>();
-            services.AddSingleton<IStepExecutor, StepExecutor>();
-            services.AddSingleton<IWorkflowMiddlewareRunner, WorkflowMiddlewareRunner>();
-            services.AddSingleton<IWorkflowMiddlewareErrorHandler, DefaultWorkflowMiddlewareErrorHandler>();
             services.AddSingleton<IWorkflowHost, WorkflowHost>();
+            services.AddTransient<IStepExecutor, StepExecutor>();
+            services.AddTransient<IWorkflowMiddlewareErrorHandler, DefaultWorkflowMiddlewareErrorHandler>();
+            services.AddTransient<IWorkflowMiddlewareRunner, WorkflowMiddlewareRunner>();
             services.AddTransient<IScopeProvider, ScopeProvider>();
             services.AddTransient<IWorkflowExecutor, WorkflowExecutor>();
             services.AddTransient<ICancellationProcessor, CancellationProcessor>();

src/WorkflowCore/Services/WorkflowController.cs

@@ -21,10 +21,9 @@ public class WorkflowController : IWorkflowController
         private readonly IExecutionPointerFactory _pointerFactory;
         private readonly ILifeCycleEventHub _eventHub;
         private readonly IServiceProvider _serviceProvider;
-        private readonly IWorkflowMiddlewareRunner _middlewareRunner;
         private readonly ILogger _logger;
 
-        public WorkflowController(IPersistenceProvider persistenceStore, IDistributedLockProvider lockProvider, IWorkflowRegistry registry, IQueueProvider queueProvider, IExecutionPointerFactory pointerFactory, ILifeCycleEventHub eventHub, ILoggerFactory loggerFactory, IServiceProvider serviceProvider, IWorkflowMiddlewareRunner middlewareRunner)
+        public WorkflowController(IPersistenceProvider persistenceStore, IDistributedLockProvider lockProvider, IWorkflowRegistry registry, IQueueProvider queueProvider, IExecutionPointerFactory pointerFactory, ILifeCycleEventHub eventHub, ILoggerFactory loggerFactory, IServiceProvider serviceProvider)
         {
             _persistenceStore = persistenceStore;
             _lockProvider = lockProvider;
@@ -33,7 +32,6 @@ public WorkflowController(IPersistenceProvider persistenceStore, IDistributedLoc
             _pointerFactory = pointerFactory;
             _eventHub = eventHub;
             _serviceProvider = serviceProvider;
-            _middlewareRunner = middlewareRunner;
             _logger = loggerFactory.CreateLogger<WorkflowController>();
         }
 
@@ -85,7 +83,11 @@ public async Task<string> StartWorkflow<TData>(string workflowId, int? version,
 
             wf.ExecutionPointers.Add(_pointerFactory.BuildGenesisPointer(def));
 
-            await _middlewareRunner.RunPreMiddleware(wf, def);
+            using (var scope = _serviceProvider.CreateScope())
+            {
+                var middlewareRunner = scope.ServiceProvider.GetRequiredService<IWorkflowMiddlewareRunner>();
+                await middlewareRunner.RunPreMiddleware(wf, def);
+            }
 
             string id = await _persistenceStore.CreateNewWorkflow(wf);
             await _queueProvider.QueueWork(id, QueueType.Workflow);

src/WorkflowCore/Services/WorkflowExecutor.cs

@@ -22,12 +22,10 @@ public class WorkflowExecutor : IWorkflowExecutor
         private readonly ICancellationProcessor _cancellationProcessor;
         private readonly ILifeCycleEventPublisher _publisher;
         private readonly WorkflowOptions _options;
-        private readonly IStepExecutor _stepExecutor;
-        private readonly IWorkflowMiddlewareRunner _middlewareRunner;
 
         private IWorkflowHost Host => _serviceProvider.GetService<IWorkflowHost>();
 
-        public WorkflowExecutor(IWorkflowRegistry registry, IServiceProvider serviceProvider, IScopeProvider scopeProvider, IDateTimeProvider datetimeProvider, IExecutionResultProcessor executionResultProcessor, ILifeCycleEventPublisher publisher, ICancellationProcessor cancellationProcessor, WorkflowOptions options, IWorkflowMiddlewareRunner middlewareRunner, IStepExecutor stepExecutor, ILoggerFactory loggerFactory)
+        public WorkflowExecutor(IWorkflowRegistry registry, IServiceProvider serviceProvider, IScopeProvider scopeProvider, IDateTimeProvider datetimeProvider, IExecutionResultProcessor executionResultProcessor, ILifeCycleEventPublisher publisher, ICancellationProcessor cancellationProcessor, WorkflowOptions options, ILoggerFactory loggerFactory)
         {
             _serviceProvider = serviceProvider;
             _scopeProvider = scopeProvider;
@@ -38,8 +36,6 @@ public WorkflowExecutor(IWorkflowRegistry registry, IServiceProvider serviceProv
             _options = options;
             _logger = loggerFactory.CreateLogger<WorkflowExecutor>();
             _executionResultProcessor = executionResultProcessor;
-            _middlewareRunner = middlewareRunner;
-            _stepExecutor = stepExecutor;
         }
 
         public async Task<WorkflowExecutorResult> Execute(WorkflowInstance workflow, CancellationToken cancellationToken = default)
@@ -157,6 +153,7 @@ private async Task ExecuteStep(WorkflowInstance workflow, WorkflowStep step, Exe
                 _logger.LogDebug("Starting step {0} on workflow {1}", step.Name, workflow.Id);
 
                 IStepBody body = step.ConstructBody(scope.ServiceProvider);
+                var stepExecutor = scope.ServiceProvider.GetRequiredService<IStepExecutor>();
 
                 if (body == null)
                 {
@@ -185,7 +182,7 @@ private async Task ExecuteStep(WorkflowInstance workflow, WorkflowStep step, Exe
                         return;
                 }
 
-                var result = await _stepExecutor.ExecuteStep(context, body);
+                var result = await stepExecutor.ExecuteStep(context, body);
 
                 if (result.Proceed)
                 {
@@ -250,7 +247,11 @@ private async Task DetermineNextExecutionTime(WorkflowInstance workflow, Workflo
             workflow.Status = WorkflowStatus.Complete;
             workflow.CompleteTime = _datetimeProvider.UtcNow;
 
-            await _middlewareRunner.RunPostMiddleware(workflow, def);
+            using (var scope = _serviceProvider.CreateScope())
+            {
+                var middlewareRunner = scope.ServiceProvider.GetRequiredService<IWorkflowMiddlewareRunner>();
+                await middlewareRunner.RunPostMiddleware(workflow, def);
+            }
 
             _publisher.PublishNotification(new WorkflowCompleted()
             {

src/WorkflowCore/WorkflowCore.csproj

@@ -15,12 +15,12 @@
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
     <Description>Workflow Core is a light weight workflow engine targeting .NET Standard.</Description>
-    <Version>3.3.2</Version>
-    <AssemblyVersion>3.3.2.0</AssemblyVersion>
-    <FileVersion>3.3.2.0</FileVersion>
+    <Version>3.3.3</Version>
+    <AssemblyVersion>3.3.3.0</AssemblyVersion>
+    <FileVersion>3.3.3.0</FileVersion>
     <PackageReleaseNotes></PackageReleaseNotes>
     <PackageIconUrl>https://github.com/danielgerlag/workflow-core/raw/master/src/logo.png</PackageIconUrl>
-    <PackageVersion>3.3.2</PackageVersion>
+    <PackageVersion>3.3.3</PackageVersion>
   </PropertyGroup>
 
   <ItemGroup>

test/WorkflowCore.UnitTests/Services/WorkflowExecutorFixture.cs

@@ -51,6 +51,14 @@ public WorkflowExecutorFixture()
             A.CallTo(() => DateTimeProvider.Now).Returns(DateTime.Now);
             A.CallTo(() => DateTimeProvider.UtcNow).Returns(DateTime.UtcNow);
 
+            A
+                .CallTo(() => ServiceProvider.GetService(typeof(IWorkflowMiddlewareRunner)))
+                .Returns(MiddlewareRunner);
+
+            A
+                .CallTo(() => ServiceProvider.GetService(typeof(IStepExecutor)))
+                .Returns(StepExecutor);
+
             A.CallTo(() => MiddlewareRunner
                     .RunPostMiddleware(A<WorkflowInstance>._, A<WorkflowDefinition>._))
                 .Returns(Task.CompletedTask);
@@ -64,7 +72,7 @@ public WorkflowExecutorFixture()
             var loggerFactory = new LoggerFactory();
             //loggerFactory.AddConsole(LogLevel.Debug);
 
-            Subject = new WorkflowExecutor(Registry, ServiceProvider, ScopeProvider, DateTimeProvider, ResultProcesser, EventHub, CancellationProcessor, Options, MiddlewareRunner, StepExecutor, loggerFactory);
+            Subject = new WorkflowExecutor(Registry, ServiceProvider, ScopeProvider, DateTimeProvider, ResultProcesser, EventHub, CancellationProcessor, Options, loggerFactory);
         }
 
         [Fact(DisplayName = "Should execute active step")]