Error string message (#261)

* Error string message

* Update ReleaseNotes.md

* Formatting Markdown

---------

Co-authored-by: Tom Longhurst <thomhurst@users.noreply.github.com>

Author: thomhurst

src/ModularPipelines.Build/Program.cs

@@ -66,4 +66,5 @@ await PipelineHostBuilder.Create()
                 .AddModule<UpdateReleaseNotesModule>();
         }
     })
+    .ConfigurePipelineOptions((context, options) => options.DefaultRetryCount = 3)
     .ExecutePipelineAsync();

src/ModularPipelines.Build/ReleaseNotes.md

@@ -1,5 +1,6 @@
 *   Chocolatey CLI helpers
+*   Not in parallel attribute for running modules without parallelisation
 
 <!---->
 
-*   Not in parallel attribute for running modules without parallelisation
+*   Better display of errored modules in the console output

src/ModularPipelines/Engine/Executors/ModuleHandlers/ErrorHandler.cs

@@ -79,6 +79,8 @@ private async Task CancelPipelineAndThrow(Exception exception)
         await Task.Delay(TimeSpan.FromMilliseconds(200));
 
         ModuleResultTaskCompletionSource.TrySetException(exception);
+        
+        Context.Logger.SetException(exception);
 
         throw new ModuleFailedException(Module, exception);
     }

src/ModularPipelines/Logging/IModuleLogger.cs

@@ -2,4 +2,7 @@
 
 namespace ModularPipelines.Logging;
 
-public interface IModuleLogger : ILogger, IDisposable, IConsoleWriter;
+public interface IModuleLogger : ILogger, IDisposable, IConsoleWriter
+{
+    internal void SetException(Exception exception);
+}

src/ModularPipelines/Logging/ModuleLogger.cs

@@ -8,6 +8,7 @@ namespace ModularPipelines.Logging;
 internal abstract class ModuleLogger : IModuleLogger
 {
     protected static readonly object Lock = new();
+    protected Exception? _exception;
 
     internal DateTime LastLogWritten { get; set; } = DateTime.MinValue;
 
@@ -20,6 +21,11 @@ internal abstract class ModuleLogger : IModuleLogger
     public abstract void Dispose();
 
     public abstract void LogToConsole(string value);
+    
+    public void SetException(Exception exception)
+    {
+        _exception = exception;
+    }
 }
 
 internal class ModuleLogger<T> : ModuleLogger, IModuleLogger, ILogger<T>
@@ -203,6 +209,11 @@ private void TryObfuscateValues(object state)
 
     private string GetCollapsibleSectionName()
     {
+        if (_exception != null)
+        {
+            return $"{typeof(T).Name} - Error! {_exception.GetType().Name}";
+        }
+
         return $"{typeof(T).Name}";
     }
 

test/ModularPipelines.UnitTests/NotInParallelTests.cs

@@ -72,7 +72,7 @@ public async Task NotInParallel()
         Assert.That(
             nextModule.StartTime.ToUnixTimeMilliseconds(),
             Is.EqualTo((firstModule.StartTime + TimeSpan.FromSeconds(1)).ToUnixTimeMilliseconds())
-                .Within(150)
+                .Within(250)
         );
     }
 
@@ -90,7 +90,7 @@ public async Task NotInParallel_With_ParallelDependency()
         Assert.That(
             nextModule.StartTime.ToUnixTimeMilliseconds(),
             Is.EqualTo((firstModule.StartTime + TimeSpan.FromSeconds(1)).ToUnixTimeMilliseconds())
-                .Within(150)
+                .Within(250)
         );
     }
 
@@ -109,7 +109,7 @@ public async Task NotInParallel_With_NonParallelDependency()
         Assert.That(
             nextModule.StartTime.ToUnixTimeMilliseconds(),
             Is.EqualTo((firstModule.StartTime + TimeSpan.FromSeconds(2)).ToUnixTimeMilliseconds())
-                .Within(150)
+                .Within(250)
         );
     }
 }