refactor(cli): Decouple console output; add CommandCompleted event

13584452567 · 13584452567 · commit 7fa1414a1492 · 2026-03-13T02:16:02.000+08:00
Refactor fastboot output handling so the driver no longer writes directly to Console. Add FastbootCommandEventArgs and a CommandCompleted event with NotifyCommandCompleted, remove default printing in NotifyCurrentStep/NotifyProgress, and route RawCommand completion through the new notifier. Expose FastbootDebug.Output delegate (CLI sets it to write to stderr) and update Program.cs to subscribe to events and perform all console formatting/printing there. Adjusted InternalDownloadDataBytes to return the raw response on protocol mismatch and replaced direct debug writes with FastbootDebug.Log. Updated tests to expect no default console output for progress/current-step.
diff --git a/FastbootCLI/Program.cs b/FastbootCLI/Program.cs
@@ -16,6 +16,7 @@ class Program
         static void Main(string[] args)
         {
             FastbootDebug.IsEnabled = Environment.GetEnvironmentVariable("FASTBOOT_DEBUG") == "1";
+            FastbootDebug.Output = message => Console.Error.WriteLine($"[DEBUG] {message}");
 
             if (args.Length == 0) { ShowHelp(); return; }
 
@@ -43,7 +44,7 @@ static void Main(string[] args)
                 }
                 else if (arg == "--debug") FastbootDebug.IsEnabled = true;
                 else if (arg == "--fallback") UsbManager.ForceLibUsb = false;
-                else if (arg == "--version" || arg == "version") { Console.WriteLine("fastboot version 1.2.5"); return; }
+                else if (arg == "--version" || arg == "version") { Console.Error.WriteLine("fastboot version 1.2.5"); return; }
                 else if (arg == "-h" || arg == "--help" || arg == "help") { ShowHelp(); return; }
                 else if (!arg.StartsWith("-"))
                 {
@@ -107,6 +108,56 @@ static void Main(string[] args)
             util.ReceivedFromDevice += (s, e) =>
             {
                 if (e.NewInfo != null) Console.Error.WriteLine("(bootloader) " + e.NewInfo);
+                if (e.NewText != null) Console.Error.Write(e.NewText);
+            };
+            util.CommandCompleted += (s, e) =>
+            {
+                if (e.Quiet) return;
+
+                var command = e.Command;
+                var response = e.Response;
+                if (response.Result == FastbootState.Fail)
+                {
+                    if (command.StartsWith("snapshot-update", StringComparison.OrdinalIgnoreCase))
+                    {
+                        Console.Error.WriteLine($"Snapshot                                           FAILED (remote: '{response.Response}')");
+                    }
+                    else if (!command.StartsWith("getvar:", StringComparison.OrdinalIgnoreCase))
+                    {
+                        Console.Error.WriteLine($"FAILED (remote: '{response.Response}')");
+                    }
+                    return;
+                }
+
+                if (command.StartsWith("devices", StringComparison.OrdinalIgnoreCase))
+                {
+                    if (!string.IsNullOrEmpty(response.Response))
+                    {
+                        Console.WriteLine(response.Response);
+                    }
+                    return;
+                }
+
+                if (string.IsNullOrEmpty(response.Response)) return;
+
+                if (command.StartsWith("getvar:", StringComparison.OrdinalIgnoreCase) &&
+                    !string.Equals(command, "getvar:all", StringComparison.OrdinalIgnoreCase))
+                {
+                    string key = command.Substring("getvar:".Length);
+                    bool alreadyPrinted = response.Info.Any(i => i.StartsWith(key + ":", StringComparison.OrdinalIgnoreCase));
+                    if (!alreadyPrinted)
+                    {
+                        Console.Error.WriteLine($"{key}: {response.Response}");
+                    }
+                }
+                else if (!command.StartsWith("getvar:all", StringComparison.OrdinalIgnoreCase))
+                {
+                    Console.Error.WriteLine(response.Response);
+                }
+            };
+            util.CurrentStepChanged += (s, step) =>
+            {
+                if (!string.IsNullOrEmpty(step)) Console.Error.WriteLine(step);
             };
 
             foreach (var cmd in pendingCommands)
diff --git a/FirmwareKit.Comm.Fastboot.Tests/FastbootProtocolTests.cs b/FirmwareKit.Comm.Fastboot.Tests/FastbootProtocolTests.cs
@@ -763,7 +763,7 @@ public void FlashUnsparseImage_ExactLimit_CompressesIfNeeded()
         }
 
         [Fact]
-        public void NotifyCurrentStep_DefaultWritesToConsole()
+        public void NotifyCurrentStep_DefaultDoesNotWriteToConsole()
         {
             var util = new FastbootDriver(new ProtocolDownloadCaptureTransport());
             using var err = new StringWriter();
@@ -773,11 +773,11 @@ public void NotifyCurrentStep_DefaultWritesToConsole()
             Console.SetError(orig);
 
             string output = err.ToString();
-            Assert.Contains("example step", output);
+            Assert.Equal(string.Empty, output);
         }
 
         [Fact]
-        public void NotifyProgress_DefaultWritesToConsole()
+        public void NotifyProgress_DefaultDoesNotWriteToConsole()
         {
             var util = new FastbootDriver(new ProtocolDownloadCaptureTransport());
             using var err = new StringWriter();
@@ -787,8 +787,7 @@ public void NotifyProgress_DefaultWritesToConsole()
             Console.SetError(orig);
 
             string output = err.ToString();
-            Assert.Contains("50/200", output);
-            Assert.Contains("25%", output);
+            Assert.Equal(string.Empty, output);
         }
 
         [Fact]
diff --git a/FirmwareKit.Comm.Fastboot/Command/InternalDownloadDataBytes.cs b/FirmwareKit.Comm.Fastboot/Command/InternalDownloadDataBytes.cs
@@ -23,12 +23,7 @@ public FastbootResponse DownloadData(byte[] data)
         FastbootResponse response = RawCommand("download:" + data.Length.ToString("x8"));
         if (response.Result != FastbootState.Data)
         {
-            return new FastbootResponse
-            {
-                Result = FastbootState.Fail,
-                Response = "protocol error: expected DATA response to download command, got " + response.Result +
-                    (string.IsNullOrEmpty(response.Response) ? string.Empty : " (" + response.Response + ")")
-            };
+            return response;
         }
         if (response.DataSize != data.Length)
         {
diff --git a/FirmwareKit.Comm.Fastboot/Command/InternalRawCommand.cs b/FirmwareKit.Comm.Fastboot/Command/InternalRawCommand.cs
@@ -38,48 +38,7 @@ public FastbootResponse RawCommand(string command, bool quiet = false)
         FastbootDebug.Log("Waiting for response...");
         var response = HandleResponse();
         FastbootDebug.Log("Response received: " + response.Response);
-
-        if (quiet)
-        {
-            return response;
-        }
-
-        if (response.Result == FastbootState.Fail)
-        {
-            if (command.StartsWith("snapshot-update", StringComparison.OrdinalIgnoreCase))
-            {
-                Console.Error.WriteLine($"Snapshot                                           FAILED (remote: '{response.Response}')");
-            }
-            else if (!command.StartsWith("getvar:", StringComparison.OrdinalIgnoreCase))
-            {
-                Console.Error.WriteLine($"FAILED (remote: '{response.Response}')");
-            }
-        }
-        else if (command.StartsWith("devices"))
-        {
-            Console.WriteLine(response.Response);
-        }
-        else if (!string.IsNullOrEmpty(response.Response))
-        {
-            if (command.StartsWith("getvar:", StringComparison.OrdinalIgnoreCase) &&
-                !string.Equals(command, "getvar:all", StringComparison.OrdinalIgnoreCase))
-            {
-                string key = command.Substring("getvar:".Length);
-                bool alreadyPrinted = response.Info.Any(i => i.StartsWith(key + ":", StringComparison.OrdinalIgnoreCase));
-                if (!alreadyPrinted)
-                {
-                    Console.Error.WriteLine($"{key}: {response.Response}");
-                }
-            }
-            else if (command.StartsWith("getvar:all", StringComparison.OrdinalIgnoreCase))
-            {
-                // Already printed via INFO
-            }
-            else
-            {
-                Console.Error.WriteLine(response.Response);
-            }
-        }
+        NotifyCommandCompleted(command, response, quiet);
 
         return response;
     }
diff --git a/FirmwareKit.Comm.Fastboot/DataModel/FastbootCommandEvent.cs b/FirmwareKit.Comm.Fastboot/DataModel/FastbootCommandEvent.cs
@@ -0,0 +1,15 @@
+namespace FirmwareKit.Comm.Fastboot;
+
+public class FastbootCommandEventArgs : EventArgs
+{
+    public string Command { get; }
+    public FastbootResponse Response { get; }
+    public bool Quiet { get; }
+
+    public FastbootCommandEventArgs(string command, FastbootResponse response, bool quiet)
+    {
+        Command = command;
+        Response = response;
+        Quiet = quiet;
+    }
+}
diff --git a/FirmwareKit.Comm.Fastboot/FastbootDebug.cs b/FirmwareKit.Comm.Fastboot/FastbootDebug.cs
@@ -3,6 +3,7 @@ namespace FirmwareKit.Comm.Fastboot;
 public static class FastbootDebug
 {
     private static bool? _debugEnabled;
+    public static Action<string>? Output;
 
     public static bool IsEnabled
     {
@@ -21,7 +22,7 @@ public static void Log(string message)
     {
         if (IsEnabled)
         {
-            Console.Error.WriteLine($"[DEBUG] {message}");
+            Output?.Invoke(message);
         }
     }
 }
diff --git a/FirmwareKit.Comm.Fastboot/FastbootDriver.cs b/FirmwareKit.Comm.Fastboot/FastbootDriver.cs
@@ -158,34 +158,24 @@ public static LpMetadata ReadFromImageStream(Stream stream)
     public event EventHandler<FastbootReceivedFromDeviceEventArgs>? ReceivedFromDevice;
     public event EventHandler<(long, long)>? DataTransferProgressChanged;
     public event EventHandler<string>? CurrentStepChanged;
+    public event EventHandler<FastbootCommandEventArgs>? CommandCompleted;
+
+    internal void NotifyCommandCompleted(string command, FastbootResponse response, bool quiet)
+    {
+        CommandCompleted?.Invoke(this, new FastbootCommandEventArgs(command, response, quiet));
+    }
 
     public void NotifyCurrentStep(string step)
     {
         FastbootDebug.Log($"NotifyCurrentStep(step={step})");
 
-        // by default write progress messages similar to the AOSP fastboot tool
-        if (string.IsNullOrEmpty(step) == false &&
-            (CurrentStepChanged == null || CurrentStepChanged.GetInvocationList().Length == 0))
-        {
-            // official fastboot prints the status text directly, no prefix
-            Console.Error.WriteLine(step);
-        }
-
         CurrentStepChanged?.Invoke(this, step);
     }
 
     public void NotifyProgress(long current, long total)
     {
         FastbootDebug.Log($"NotifyProgress(current={current}, total={total})");
         DataTransferProgressChanged?.Invoke(this, (current, total));
-
-        // if nobody is handling progress events we still print a basic line
-        if (DataTransferProgressChanged == null || DataTransferProgressChanged.GetInvocationList().Length == 0)
-        {
-            int percent = total > 0 ? (int)(current * 100 / total) : 0;
-            Console.Error.Write($"\r{current}/{total} {percent}%    ");
-            if (current == total) Console.Error.WriteLine();
-        }
     }
     public void NotifyReceived(FastbootState state, string? info = null, string? text = null)
     {
@@ -632,7 +622,7 @@ public void FlashImage(string partition, string filePath, string? slotOverride,
         }
         catch (Exception ex)
         {
-            if (FastbootDebug.IsEnabled) Console.Error.WriteLine("[DEBUG] FlashImage Failed: " + ex);
+            FastbootDebug.Log("FlashImage Failed: " + ex);
             throw;
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -763,7 +763,7 @@ public void FlashUnsparseImage_ExactLimit_CompressesIfNeeded()`
`763`	`763`	`}`
`764`	`764`
`765`	`765`	`[Fact]`
`766`		`- public void NotifyCurrentStep_DefaultWritesToConsole()`
	`766`	`+ public void NotifyCurrentStep_DefaultDoesNotWriteToConsole()`
`767`	`767`	`{`
`768`	`768`	`var util = new FastbootDriver(new ProtocolDownloadCaptureTransport());`
`769`	`769`	`using var err = new StringWriter();`
`@@ -773,11 +773,11 @@ public void NotifyCurrentStep_DefaultWritesToConsole()`
`773`	`773`	`Console.SetError(orig);`
`774`	`774`
`775`	`775`	`string output = err.ToString();`
`776`		`- Assert.Contains("example step", output);`
	`776`	`+ Assert.Equal(string.Empty, output);`
`777`	`777`	`}`
`778`	`778`
`779`	`779`	`[Fact]`
`780`		`- public void NotifyProgress_DefaultWritesToConsole()`
	`780`	`+ public void NotifyProgress_DefaultDoesNotWriteToConsole()`
`781`	`781`	`{`
`782`	`782`	`var util = new FastbootDriver(new ProtocolDownloadCaptureTransport());`
`783`	`783`	`using var err = new StringWriter();`
`@@ -787,8 +787,7 @@ public void NotifyProgress_DefaultWritesToConsole()`
`787`	`787`	`Console.SetError(orig);`
`788`	`788`
`789`	`789`	`string output = err.ToString();`
`790`		`- Assert.Contains("50/200", output);`
`791`		`- Assert.Contains("25%", output);`
	`790`	`+ Assert.Equal(string.Empty, output);`
`792`	`791`	`}`
`793`	`792`
`794`	`793`	`[Fact]`
Original file line number	Diff line number	Diff line change
`@@ -23,12 +23,7 @@ public FastbootResponse DownloadData(byte[] data)`
`23`	`23`	`FastbootResponse response = RawCommand("download:" + data.Length.ToString("x8"));`
`24`	`24`	`if (response.Result != FastbootState.Data)`
`25`	`25`	`{`
`26`		`- return new FastbootResponse`
`27`		`- {`
`28`		`- Result = FastbootState.Fail,`
`29`		`- Response = "protocol error: expected DATA response to download command, got " + response.Result +`
`30`		`- (string.IsNullOrEmpty(response.Response) ? string.Empty : " (" + response.Response + ")")`
`31`		`- };`
	`26`	`+ return response;`
`32`	`27`	`}`
`33`	`28`	`if (response.DataSize != data.Length)`
`34`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ namespace FirmwareKit.Comm.Fastboot;`
`3`	`3`	`public static class FastbootDebug`
`4`	`4`	`{`
`5`	`5`	`private static bool? _debugEnabled;`
	`6`	`+ public static Action<string>? Output;`
`6`	`7`
`7`	`8`	`public static bool IsEnabled`
`8`	`9`	`{`
`@@ -21,7 +22,7 @@ public static void Log(string message)`
`21`	`22`	`{`
`22`	`23`	`if (IsEnabled)`
`23`	`24`	`{`
`24`		`- Console.Error.WriteLine($"[DEBUG] {message}");`
	`25`	`+ Output?.Invoke(message);`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -158,34 +158,24 @@ public static LpMetadata ReadFromImageStream(Stream stream)`
`158`	`158`	`public event EventHandler<FastbootReceivedFromDeviceEventArgs>? ReceivedFromDevice;`
`159`	`159`	`public event EventHandler<(long, long)>? DataTransferProgressChanged;`
`160`	`160`	`public event EventHandler<string>? CurrentStepChanged;`
	`161`	`+ public event EventHandler<FastbootCommandEventArgs>? CommandCompleted;`
	`162`	`+`
	`163`	`+ internal void NotifyCommandCompleted(string command, FastbootResponse response, bool quiet)`
	`164`	`+ {`
	`165`	`+ CommandCompleted?.Invoke(this, new FastbootCommandEventArgs(command, response, quiet));`
	`166`	`+ }`
`161`	`167`
`162`	`168`	`public void NotifyCurrentStep(string step)`
`163`	`169`	`{`
`164`	`170`	`FastbootDebug.Log($"NotifyCurrentStep(step={step})");`
`165`	`171`
`166`		`- // by default write progress messages similar to the AOSP fastboot tool`
`167`		`- if (string.IsNullOrEmpty(step) == false &&`
`168`		`- (CurrentStepChanged == null \|\| CurrentStepChanged.GetInvocationList().Length == 0))`
`169`		`- {`
`170`		`- // official fastboot prints the status text directly, no prefix`
`171`		`- Console.Error.WriteLine(step);`
`172`		`- }`
`173`		`-`
`174`	`172`	`CurrentStepChanged?.Invoke(this, step);`
`175`	`173`	`}`
`176`	`174`
`177`	`175`	`public void NotifyProgress(long current, long total)`
`178`	`176`	`{`
`179`	`177`	`FastbootDebug.Log($"NotifyProgress(current={current}, total={total})");`
`180`	`178`	`DataTransferProgressChanged?.Invoke(this, (current, total));`
`181`		`-`
`182`		`- // if nobody is handling progress events we still print a basic line`
`183`		`- if (DataTransferProgressChanged == null \|\| DataTransferProgressChanged.GetInvocationList().Length == 0)`
`184`		`- {`
`185`		`- int percent = total > 0 ? (int)(current * 100 / total) : 0;`
`186`		`- Console.Error.Write($"\r{current}/{total} {percent}% ");`
`187`		`- if (current == total) Console.Error.WriteLine();`
`188`		`- }`
`189`	`179`	`}`
`190`	`180`	`public void NotifyReceived(FastbootState state, string? info = null, string? text = null)`
`191`	`181`	`{`
`@@ -632,7 +622,7 @@ public void FlashImage(string partition, string filePath, string? slotOverride,`
`632`	`622`	`}`
`633`	`623`	`catch (Exception ex)`
`634`	`624`	`{`
`635`		`- if (FastbootDebug.IsEnabled) Console.Error.WriteLine("[DEBUG] FlashImage Failed: " + ex);`
	`625`	`+ FastbootDebug.Log("FlashImage Failed: " + ex);`
`636`	`626`	`throw;`
`637`	`627`	`}`
`638`	`628`	`}`