Allow to disable events publisher

viktorkryzhanovksyilangai · viktorkryzhanovksyilangai · commit b43785b03ace · 2021-08-03T18:50:25.000+03:00
diff --git a/src/WorkflowCore/Models/WorkflowOptions.cs b/src/WorkflowCore/Models/WorkflowOptions.cs
@@ -38,6 +38,7 @@ public WorkflowOptions(IServiceCollection services)
         public bool EnableEvents { get; set; } = true;
         public bool EnableIndexes { get; set; } = true;
         public bool EnablePolling { get; set; } = true;
+        public bool EnableLifeCycleEventsPublisher { get; set; } = true;
 
         public void UsePersistence(Func<IServiceProvider, IPersistenceProvider> factory)
         {
diff --git a/src/WorkflowCore/ServiceCollectionExtensions.cs b/src/WorkflowCore/ServiceCollectionExtensions.cs
@@ -31,7 +31,16 @@ public static IServiceCollection AddWorkflow(this IServiceCollection services, A
 
             services.AddSingleton<IWorkflowRegistry, WorkflowRegistry>();
             services.AddSingleton<WorkflowOptions>(options);
-            services.AddSingleton<ILifeCycleEventPublisher, LifeCycleEventPublisher>();
+
+            if (options.EnableLifeCycleEventsPublisher)
+            {
+                services.AddSingleton<ILifeCycleEventPublisher, LifeCycleEventPublisher>();
+                services.AddTransient<IBackgroundTask>(sp => sp.GetService<ILifeCycleEventPublisher>());
+            }
+            else
+            {
+                services.AddTransient<ILifeCycleEventPublisher>(provider => null);
+            }
 
             if (options.EnableWorkflows)
             {
@@ -53,8 +62,6 @@ public static IServiceCollection AddWorkflow(this IServiceCollection services, A
                 services.AddTransient<IBackgroundTask, RunnablePoller>();
             }
 
-            services.AddTransient<IBackgroundTask>(sp => sp.GetService<ILifeCycleEventPublisher>());
-
             services.AddTransient<IWorkflowErrorHandler, CompensateHandler>();
             services.AddTransient<IWorkflowErrorHandler, RetryHandler>();
             services.AddTransient<IWorkflowErrorHandler, TerminateHandler>();
diff --git a/src/WorkflowCore/Services/ErrorHandlers/CompensateHandler.cs b/src/WorkflowCore/Services/ErrorHandlers/CompensateHandler.cs
@@ -8,17 +8,15 @@ namespace WorkflowCore.Services.ErrorHandlers
 {
     public class CompensateHandler : IWorkflowErrorHandler
     {
-        private readonly ILifeCycleEventPublisher _eventPublisher;
         private readonly IExecutionPointerFactory _pointerFactory;
         private readonly IDateTimeProvider _datetimeProvider;
         private readonly WorkflowOptions _options;
 
         public WorkflowErrorHandling Type => WorkflowErrorHandling.Compensate;
 
-        public CompensateHandler(IExecutionPointerFactory pointerFactory, ILifeCycleEventPublisher eventPublisher, IDateTimeProvider datetimeProvider, WorkflowOptions options)
+        public CompensateHandler(IExecutionPointerFactory pointerFactory, IDateTimeProvider datetimeProvider, WorkflowOptions options)
         {
             _pointerFactory = pointerFactory;
-            _eventPublisher = eventPublisher;
             _datetimeProvider = datetimeProvider;
             _options = options;
         }
diff --git a/src/WorkflowCore/Services/ErrorHandlers/SuspendHandler.cs b/src/WorkflowCore/Services/ErrorHandlers/SuspendHandler.cs
@@ -21,7 +21,7 @@ public SuspendHandler(ILifeCycleEventPublisher eventPublisher, IDateTimeProvider
         public void Handle(WorkflowInstance workflow, WorkflowDefinition def, ExecutionPointer pointer, WorkflowStep step, Exception exception, Queue<ExecutionPointer> bubbleUpQueue)
         {
             workflow.Status = WorkflowStatus.Suspended;
-            _eventPublisher.PublishNotification(new WorkflowSuspended
+            _eventPublisher?.PublishNotification(new WorkflowSuspended
             {
                 EventTimeUtc = _datetimeProvider.UtcNow,
                 Reference = workflow.Reference,
diff --git a/src/WorkflowCore/Services/ErrorHandlers/TerminateHandler.cs b/src/WorkflowCore/Services/ErrorHandlers/TerminateHandler.cs
@@ -23,7 +23,7 @@ public void Handle(WorkflowInstance workflow, WorkflowDefinition def, ExecutionP
             workflow.Status = WorkflowStatus.Terminated;
             workflow.CompleteTime = _dateTimeProvider.UtcNow;
 
-            _eventPublisher.PublishNotification(new WorkflowTerminated
+            _eventPublisher?.PublishNotification(new WorkflowTerminated
             {
                 EventTimeUtc = _dateTimeProvider.UtcNow,
                 Reference = workflow.Reference,
diff --git a/src/WorkflowCore/Services/ExecutionResultProcessor.cs b/src/WorkflowCore/Services/ExecutionResultProcessor.cs
@@ -77,7 +77,7 @@ public void ProcessExecutionResult(WorkflowInstance workflow, WorkflowDefinition
                     subsequent.Active = true;
                 }
 
-                _eventPublisher.PublishNotification(new StepCompleted
+                _eventPublisher?.PublishNotification(new StepCompleted
                 {
                     EventTimeUtc = _datetimeProvider.UtcNow,
                     Reference = workflow.Reference,
@@ -102,7 +102,7 @@ public void ProcessExecutionResult(WorkflowInstance workflow, WorkflowDefinition
 
         public void HandleStepException(WorkflowInstance workflow, WorkflowDefinition def, ExecutionPointer pointer, WorkflowStep step, Exception exception)
         {
-            _eventPublisher.PublishNotification(new WorkflowError
+            _eventPublisher?.PublishNotification(new WorkflowError
             {
                 EventTimeUtc = _datetimeProvider.UtcNow,
                 Reference = workflow.Reference,
diff --git a/src/WorkflowCore/Services/WorkflowExecutor.cs b/src/WorkflowCore/Services/WorkflowExecutor.cs
@@ -123,7 +123,7 @@ private bool InitializeStep(WorkflowInstance workflow, WorkflowStep step, Workfl
             if (pointer.Status != PointerStatus.Running)
             {
                 pointer.Status = PointerStatus.Running;
-                _publisher.PublishNotification(new StepStarted
+                _publisher?.PublishNotification(new StepStarted
                 {
                     EventTimeUtc = _datetimeProvider.UtcNow,
                     Reference = workflow.Reference,
@@ -264,7 +264,7 @@ private async Task DetermineNextExecutionTime(WorkflowInstance workflow, Workflo
                 await middlewareRunner.RunPostMiddleware(workflow, def);
             }
 
-            _publisher.PublishNotification(new WorkflowCompleted
+            _publisher?.PublishNotification(new WorkflowCompleted
             {
                 EventTimeUtc = _datetimeProvider.UtcNow,
                 Reference = workflow.Reference,

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ public WorkflowOptions(IServiceCollection services)`
`38`	`38`	`public bool EnableEvents { get; set; } = true;`
`39`	`39`	`public bool EnableIndexes { get; set; } = true;`
`40`	`40`	`public bool EnablePolling { get; set; } = true;`
	`41`	`+ public bool EnableLifeCycleEventsPublisher { get; set; } = true;`
`41`	`42`
`42`	`43`	`public void UsePersistence(Func<IServiceProvider, IPersistenceProvider> factory)`
`43`	`44`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,17 +8,15 @@ namespace WorkflowCore.Services.ErrorHandlers`
`8`	`8`	`{`
`9`	`9`	`public class CompensateHandler : IWorkflowErrorHandler`
`10`	`10`	`{`
`11`		`- private readonly ILifeCycleEventPublisher _eventPublisher;`
`12`	`11`	`private readonly IExecutionPointerFactory _pointerFactory;`
`13`	`12`	`private readonly IDateTimeProvider _datetimeProvider;`
`14`	`13`	`private readonly WorkflowOptions _options;`
`15`	`14`
`16`	`15`	`public WorkflowErrorHandling Type => WorkflowErrorHandling.Compensate;`
`17`	`16`
`18`		`- public CompensateHandler(IExecutionPointerFactory pointerFactory, ILifeCycleEventPublisher eventPublisher, IDateTimeProvider datetimeProvider, WorkflowOptions options)`
	`17`	`+ public CompensateHandler(IExecutionPointerFactory pointerFactory, IDateTimeProvider datetimeProvider, WorkflowOptions options)`
`19`	`18`	`{`
`20`	`19`	`_pointerFactory = pointerFactory;`
`21`		`- _eventPublisher = eventPublisher;`
`22`	`20`	`_datetimeProvider = datetimeProvider;`
`23`	`21`	`_options = options;`
`24`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public SuspendHandler(ILifeCycleEventPublisher eventPublisher, IDateTimeProvider`
`21`	`21`	`public void Handle(WorkflowInstance workflow, WorkflowDefinition def, ExecutionPointer pointer, WorkflowStep step, Exception exception, Queue<ExecutionPointer> bubbleUpQueue)`
`22`	`22`	`{`
`23`	`23`	`workflow.Status = WorkflowStatus.Suspended;`
`24`		`- _eventPublisher.PublishNotification(new WorkflowSuspended`
	`24`	`+ _eventPublisher?.PublishNotification(new WorkflowSuspended`
`25`	`25`	`{`
`26`	`26`	`EventTimeUtc = _datetimeProvider.UtcNow,`
`27`	`27`	`Reference = workflow.Reference,`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public void Handle(WorkflowInstance workflow, WorkflowDefinition def, ExecutionP`
`23`	`23`	`workflow.Status = WorkflowStatus.Terminated;`
`24`	`24`	`workflow.CompleteTime = _dateTimeProvider.UtcNow;`
`25`	`25`
`26`		`- _eventPublisher.PublishNotification(new WorkflowTerminated`
	`26`	`+ _eventPublisher?.PublishNotification(new WorkflowTerminated`
`27`	`27`	`{`
`28`	`28`	`EventTimeUtc = _dateTimeProvider.UtcNow,`
`29`	`29`	`Reference = workflow.Reference,`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public void ProcessExecutionResult(WorkflowInstance workflow, WorkflowDefinition`
`77`	`77`	`subsequent.Active = true;`
`78`	`78`	`}`
`79`	`79`
`80`		`- _eventPublisher.PublishNotification(new StepCompleted`
	`80`	`+ _eventPublisher?.PublishNotification(new StepCompleted`
`81`	`81`	`{`
`82`	`82`	`EventTimeUtc = _datetimeProvider.UtcNow,`
`83`	`83`	`Reference = workflow.Reference,`
`@@ -102,7 +102,7 @@ public void ProcessExecutionResult(WorkflowInstance workflow, WorkflowDefinition`
`102`	`102`
`103`	`103`	`public void HandleStepException(WorkflowInstance workflow, WorkflowDefinition def, ExecutionPointer pointer, WorkflowStep step, Exception exception)`
`104`	`104`	`{`
`105`		`- _eventPublisher.PublishNotification(new WorkflowError`
	`105`	`+ _eventPublisher?.PublishNotification(new WorkflowError`
`106`	`106`	`{`
`107`	`107`	`EventTimeUtc = _datetimeProvider.UtcNow,`
`108`	`108`	`Reference = workflow.Reference,`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ private bool InitializeStep(WorkflowInstance workflow, WorkflowStep step, Workfl`
`123`	`123`	`if (pointer.Status != PointerStatus.Running)`
`124`	`124`	`{`
`125`	`125`	`pointer.Status = PointerStatus.Running;`
`126`		`- _publisher.PublishNotification(new StepStarted`
	`126`	`+ _publisher?.PublishNotification(new StepStarted`
`127`	`127`	`{`
`128`	`128`	`EventTimeUtc = _datetimeProvider.UtcNow,`
`129`	`129`	`Reference = workflow.Reference,`
`@@ -264,7 +264,7 @@ private async Task DetermineNextExecutionTime(WorkflowInstance workflow, Workflo`
`264`	`264`	`await middlewareRunner.RunPostMiddleware(workflow, def);`
`265`	`265`	`}`
`266`	`266`
`267`		`- _publisher.PublishNotification(new WorkflowCompleted`
	`267`	`+ _publisher?.PublishNotification(new WorkflowCompleted`
`268`	`268`	`{`
`269`	`269`	`EventTimeUtc = _datetimeProvider.UtcNow,`
`270`	`270`	`Reference = workflow.Reference,`