Properly using SpectreConsole's AnsiConsole.Live, creating a simple custom confirmation prompt. (#236)

Fixes #225

Author: azchohfi

src/winapp-CLI/Directory.Packages.props

@@ -4,7 +4,7 @@
     <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="10.0.2" />
     <PackageVersion Include="Spectre.Console" Version="0.54.0" />
     <PackageVersion Include="Spectre.Console.Testing" Version="0.54.0" />
-    <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.264" />
+    <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.269" />
     <PackageVersion Include="System.CommandLine" Version="2.0.2" />
     <PackageVersion Include="System.Diagnostics.EventLog" Version="10.0.2" />
     <PackageVersion Include="Microsoft.Telemetry.Inbox.Managed" Version="10.0.25148.1001-220626-1600.rs-fun-deploy-dev5" />

src/winapp-CLI/WinApp.Cli.Tests/BaseCommandTests.cs

@@ -26,7 +26,7 @@ public abstract class BaseCommandTests(bool configPaths = true, bool verboseLogg
 
     public TestContext TestContext { get; set; } = null!;
     private protected TaskContext TestTaskContext { private set; get; } = null!;
-    private protected LiveUpdateSignal LiveUpdateSignal { private set; get; } = null!;
+    private protected Lock RenderLock { private set; get; } = null!;
     private protected TestConsole TestAnsiConsole { private set; get; } = null!;
 
     [TestInitialize]
@@ -64,8 +64,8 @@ public void SetupBase()
 
         GroupableTask dummyTask = new GroupableTask("Dummy Task", null);
 
-        LiveUpdateSignal = new LiveUpdateSignal();
-        TestTaskContext = new TaskContext(dummyTask, null, TestAnsiConsole, GetRequiredService<ILogger<TaskContext>>(), LiveUpdateSignal);
+        RenderLock = new Lock();
+        TestTaskContext = new TaskContext(dummyTask, null, TestAnsiConsole, GetRequiredService<ILogger<TaskContext>>(), RenderLock);
 
         // Set up services with test cache directory
         if (configPaths)

src/winapp-CLI/WinApp.Cli.Tests/ManifestUpdateAssetsCommandTests.cs

@@ -232,7 +232,7 @@ public async Task ManifestUpdateAssetsCommandShouldLogProgress()
         // Assert
         Assert.AreEqual(0, exitCode, "Update-assets command should complete successfully");
 
-        Assert.Contains("Updating manifest assets", TestAnsiConsole.Output, "Should log update message");
+        Assert.Contains("Updating assets for manifest", TestAnsiConsole.Output, "Should log update message");
         Assert.Contains("generated", TestAnsiConsole.Output.ToLowerInvariant(), "Should log generation progress");
     }
 

src/winapp-CLI/WinApp.Cli/Commands/SignCommand.cs

@@ -3,7 +3,6 @@
 
 using System.CommandLine;
 using System.CommandLine.Invocation;
-using WinApp.Cli.Helpers;
 using WinApp.Cli.Services;
 
 namespace WinApp.Cli.Commands;

src/winapp-CLI/WinApp.Cli/ConsoleTasks/GroupableTask.cs

@@ -17,6 +17,7 @@ internal class GroupableTask(string inProgressMessage, GroupableTask? parent) :
     public bool IsCompleted { get; protected set; }
     public GroupableTask? Parent { get; } = parent;
     public string InProgressMessage { get; set; } = inProgressMessage;
+    public bool EscapeInProgressMessage { get; set; } = true;
     public string? SubStatus { get; set; }
 
     public void Dispose()
@@ -33,16 +34,16 @@ internal class GroupableTask<T> : GroupableTask
     public T? CompletedMessage { get; protected set; }
     private readonly Func<TaskContext, CancellationToken, Task<T>>? _taskFunc;
     protected readonly IAnsiConsole AnsiConsole;
-    protected readonly LiveUpdateSignal Signal;
+    protected readonly Lock RenderLock;
     private readonly ILogger _logger;
 
-    public GroupableTask(string inProgressMessage, GroupableTask? parent, Func<TaskContext, CancellationToken, Task<T>>? taskFunc, IAnsiConsole ansiConsole, ILogger logger, LiveUpdateSignal signal)
+    public GroupableTask(string inProgressMessage, GroupableTask? parent, Func<TaskContext, CancellationToken, Task<T>>? taskFunc, IAnsiConsole ansiConsole, ILogger logger, Lock renderLock)
         : base(inProgressMessage, parent)
     {
         _taskFunc = taskFunc;
         AnsiConsole = ansiConsole;
         _logger = logger;
-        Signal = signal;
+        RenderLock = renderLock;
     }
 
     public virtual async Task<T?> ExecuteAsync(Action? onUpdate, CancellationToken cancellationToken, bool startSpinner = true)
@@ -53,7 +54,7 @@ public GroupableTask(string inProgressMessage, GroupableTask? parent, Func<TaskC
         {
             if (_taskFunc != null)
             {
-                var context = new TaskContext(this, onUpdate, AnsiConsole, _logger, Signal);
+                var context = new TaskContext(this, onUpdate, AnsiConsole, _logger, RenderLock);
                 CompletedMessage = await _taskFunc(context, cancellationToken);
                 IsCompleted = true;
             }
@@ -72,43 +73,47 @@ public GroupableTask(string inProgressMessage, GroupableTask? parent, Func<TaskC
         return CompletedMessage;
     }
 
-    public (IRenderable, int) Render()
+    public IRenderable Render()
     {
         var sb = new StringBuilder();
 
         int maxDepth = _logger.IsEnabled(LogLevel.Debug) ? int.MaxValue : 1;
-        var lineCount = RenderTask(this, sb, 0, string.Empty, maxDepth);
+        RenderTask(this, sb, 0, string.Empty, maxDepth);
+        var allTasksString = sb.ToString().TrimEnd([.. Environment.NewLine]);
+        if (!allTasksString.Contains(Environment.NewLine))
+        {
+            allTasksString = $"{allTasksString}{Environment.NewLine}";
+        }
 
-        var panel = new Panel(new Markup(sb.ToString().TrimEnd([.. Environment.NewLine])))
+        var panel = new Panel(allTasksString)
         {
             Border = BoxBorder.None,
             Padding = new Padding(0, 0),
             Expand = true
         };
 
-        return (panel, lineCount);
+        return panel;
     }
 
-    private static int RenderSubTasks(GroupableTask task, StringBuilder sb, int indentLevel, int maxForcedDepth)
+    private static void RenderSubTasks(GroupableTask task, StringBuilder sb, int indentLevel, int maxForcedDepth)
     {
         if (task.SubTasks.Count == 0)
         {
-            return 0;
+            return;
         }
 
         var indentStr = new string(' ', indentLevel * 2);
-        int lineCount = 0;
 
         foreach (var subTask in task.SubTasks)
         {
-            lineCount += RenderTask(subTask, sb, indentLevel, indentStr, maxForcedDepth);
+            RenderTask(subTask, sb, indentLevel, indentStr, maxForcedDepth);
         }
-
-        return lineCount;
     }
 
-    private static int RenderTask(GroupableTask task, StringBuilder sb, int indentLevel, string indentStr, int maxForcedDepth)
+    private static void RenderTask(GroupableTask task, StringBuilder sb, int indentLevel, string indentStr, int maxForcedDepth)
     {
+        string msg;
+
         if (task.IsCompleted)
         {
             static string FormatCheckMarkMessage(string indentStr, string message)
@@ -123,7 +128,8 @@ static string FormatCheckMarkMessage(string indentStr, string message)
                 }
                 return firstCharIsEmojiOrOpenBracket ? $"{indentStr} {message}" : $"{indentStr}[green]{Emoji.Known.CheckMarkButton}[/] {message}";
             }
-            sb.AppendLine(task switch
+
+            msg = task switch
             {
                 StatusMessageTask statusMessageTask => $"{indentStr} {Markup.Escape(statusMessageTask.CompletedMessage ?? string.Empty)}",
                 GroupableTask<T> genericTask => FormatCheckMarkMessage(indentStr, (genericTask.CompletedMessage as ITuple) switch
@@ -133,31 +139,38 @@ static string FormatCheckMarkMessage(string indentStr, string message)
                     _ => genericTask.CompletedMessage?.ToString() ?? string.Empty
                 }),
                 GroupableTask _ => FormatCheckMarkMessage(indentStr, Markup.Escape(task.InProgressMessage)),
-            });
+            };
         }
         else
         {
             var spinnerChars = new[] { "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" };
             var spinnerIndex = (int)(DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() / 100) % spinnerChars.Length;
             var spinner = spinnerChars[spinnerIndex];
 
-            var msg = task.InProgressMessage;
+            msg = task.InProgressMessage;
             if (!string.IsNullOrEmpty(task.SubStatus))
             {
                 msg = $"{msg} ({task.SubStatus})";
             }
-
-            sb.AppendLine($"{indentStr}[yellow]{spinner}[/]  {Markup.Escape(msg)}");
+            if (task.EscapeInProgressMessage)
+            {
+                msg = Markup.Escape(msg);
+            }
+            if (task is not PromptConfirmationTask promptConfirmationTask || promptConfirmationTask.State != PromptState.WaitingForInput)
+            {
+                msg = $"{indentStr}[yellow]{spinner}[/]  {msg}";
+            }
         }
 
-        int lineCount = 1;
+        // make line endings consistent
+        msg = msg.Replace("\r\n", "\n").Replace("\r", "\n").Replace("\n", Environment.NewLine).TrimEnd([.. Environment.NewLine]);
+
+        sb.AppendLine(msg);
 
         bool shouldRenderChildren = indentLevel + 1 <= maxForcedDepth || !task.IsCompleted;
         if (shouldRenderChildren)
         {
-            lineCount += RenderSubTasks(task, sb, indentLevel + 1, maxForcedDepth);
+            RenderSubTasks(task, sb, indentLevel + 1, maxForcedDepth);
         }
-
-        return lineCount;
     }
 }