Merge pull request #24 from DevJasperNL/feature/pipeline_logging

Added optional logging to Pipeline.

Author: DevJasperNL

src/AutomationPipelines/AutomationPipelines.csproj

@@ -29,8 +29,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.6" />
-    <PackageReference Include="System.Reactive" Version="6.0.1" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.8" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.8" />
+    <PackageReference Include="System.Reactive" Version="6.0.2" />
   </ItemGroup>
 
 </Project>

src/AutomationPipelines/Pipeline.cs

@@ -1,29 +1,46 @@
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 
 namespace AutomationPipelines;
 
 /// <summary>
 /// Represents a pipeline of nodes.
 /// </summary>
-public class Pipeline<TState>(IServiceProvider serviceProvider) : PipelineNode<TState>, IPipeline<TState>
+public class Pipeline<TState> : PipelineNode<TState>, IPipeline<TState>
 {
     private readonly List<IPipelineNode<TState>> _nodes = new();
+    private ILogger<Pipeline<TState>>? _logger;
 
     private bool _callActionDistinct = true;
     private Action<TState>? _action;
     private IDisposable? _subscription;
+    private readonly IServiceProvider _serviceProvider;
+
+    /// <inheritdoc />
+    public Pipeline(IServiceProvider serviceProvider)
+    {
+        _serviceProvider = serviceProvider;
+    }
+
+    /// <inheritdoc />
+    public Pipeline(IServiceProvider serviceProvider, ILogger<Pipeline<TState>>? logger)
+    {
+        _serviceProvider = serviceProvider;
+        _logger = logger;
+    }
 
     /// <inheritdoc />
     public IPipeline<TState> SetDefault(TState state)
     {
         Input = state;
+        _logger?.LogDebug($"Default value set to {state}.");
         return this;
     }
 
     /// <inheritdoc />
     public IPipeline<TState> RegisterNode<TNode>() where TNode : IPipelineNode<TState>
     {
-        return RegisterNode(ActivatorUtilities.CreateInstance<TNode>(serviceProvider));
+        return RegisterNode(ActivatorUtilities.CreateInstance<TNode>(_serviceProvider));
     }
 
     /// <inheritdoc />
@@ -35,13 +52,19 @@ public IPipeline<TState> RegisterNode<TNode>(TNode node) where TNode : IPipeline
         if (_nodes.Any())
         {
             var previousNode = _nodes.Last();
-            previousNode.OnNewOutput.Subscribe(output => node.Input = output);
+            previousNode.OnNewOutput.Subscribe(output =>
+            {
+                node.Input = output;
+                _logger?.LogTrace($"Node {previousNode} passed value {output} to node {node}.");
+            });
 
             node.Input = previousNode.Output;
         }
 
         _nodes.Add(node);
 
+        _logger?.LogDebug($"Node {node} registered.");
+
         if (_nodes.Count == 1)
         {
             node.Input = Input;
@@ -55,6 +78,10 @@ public IPipeline<TState> RegisterNode<TNode>(TNode node) where TNode : IPipeline
     /// <inheritdoc />
     public IPipeline<TState> SetOutputHandler(Action<TState> action, bool callActionDistinct = true)
     {
+        _logger?.LogDebug(callActionDistinct
+            ? "Setting output handler."
+            : "Setting output handler. Action calls with duplicate values are allowed.");
+
         _callActionDistinct = callActionDistinct;
         _action = action;
         if (Output != null)
@@ -68,25 +95,40 @@ public IPipeline<TState> SetOutputHandler(Action<TState> action, bool callAction
     /// <inheritdoc />
     protected override void InputReceived(TState? state)
     {
+        _logger?.LogDebug($"Input set to {state}.");
         if (!_nodes.Any())
         {
+            _logger?.LogTrace($"No nodes, calling action immediately with {state}.");
             SetOutputAndCallActionWhenApplicable(Input);
             return;
         }
 
-        _nodes.First().Input = Input;
+        var firstNode = _nodes.First();
+        _logger?.LogTrace($"Passing input {state} to first node {firstNode}.");
+        firstNode.Input = Input;
     }
 
     private void SetOutputAndCallActionWhenApplicable(TState? output)
     {
         var outputChanged = !EqualityComparer<TState>.Default.Equals(Output, output);
 
         Output = output;
+        _logger?.LogDebug($"Pipeline output set to {output}.");
+
+        if (output == null)
+        {
+            _logger?.LogTrace("No action set to execute.");
+            return;
+        }
 
-        if (output != null && (!_callActionDistinct || outputChanged))
+        if (_callActionDistinct && !outputChanged)
         {
-            // Note that _action will be called AFTER OnNewOutput.
-            _action?.Invoke(output);
+            _logger?.LogTrace("No action executed as output has not changed.");
+            return;
         }
+
+        // Note that _action will be called AFTER OnNewOutput.
+        _action?.Invoke(output);
+        _logger?.LogTrace($"Action executed with value {output}.");
     }
 }

src/AutomationPipelines/PipelineNode.cs

@@ -56,8 +56,8 @@ protected void PassInputThrough()
     }
 
     /// <summary>
-    /// Sets the output state of the node. This will trigger the processing of the input.
-    /// If the node is disabled, it will be enabled when setting an output value.
+    /// Sets the output state of the node.
+    /// If pass-through mode is enabled for this node it will be disabled when setting an output value.
     /// </summary>
     public TState? Output
     {
@@ -77,7 +77,7 @@ public bool PassThrough
         get => _passThrough;
         set
         {
-            // Always reset _disableOnNextInput when Enabled is explicitly called.
+            // Always reset _passThroughNextInput when PassThrough is explicitly called.
             _passThroughNextInput = false;
 
             if (_passThrough == value)

tests/AutomationPipelines.Tests/AutomationPipelines.Tests.csproj

@@ -18,9 +18,9 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
     <PackageReference Include="Microsoft.Testing.Extensions.CodeCoverage" Version="17.14.2" />
-    <PackageReference Include="Microsoft.Testing.Extensions.TrxReport" Version="1.7.2" />
+    <PackageReference Include="Microsoft.Testing.Extensions.TrxReport" Version="1.8.4" />
     <PackageReference Include="Moq" Version="4.20.72" />
-    <PackageReference Include="MSTest" Version="3.9.2" />
+    <PackageReference Include="MSTest" Version="3.10.4" />
   </ItemGroup>
 
   <ItemGroup>