Improve tracing and error logging in update strategies

JusterZhu · JusterZhu · commit 5b572a879a3d · 2025-08-27T15:33:27.000+08:00
Added detailed tracing and error logging to LinuxStrategy, WindowsStrategy, and bootstrap classes in both ClientCore and Core projects. Enhanced multi-download event handlers with trace messages and standardized exception logging for better diagnostics and maintainability.
diff --git a/src/c#/GeneralUpdate.ClientCore/GeneralClientBootstrap.cs b/src/c#/GeneralUpdate.ClientCore/GeneralClientBootstrap.cs
@@ -375,6 +375,7 @@ private void CallSmallBowlHome(string processName)
         }
         catch (Exception ex)
         {
+            GeneralTracer.Error("The CallSmallBowlHome method in the GeneralClientBootstrap class throws an exception.", ex);
             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(ex, ex.Message));
         }
     }
@@ -393,6 +394,7 @@ private void ExecuteCustomOptions()
             {
                 var exception = new Exception($"{nameof(option)}Execution failure!");
                 var args = new ExceptionEventArgs(exception, exception.Message);
+                GeneralTracer.Error("The ExecuteCustomOptions method in the GeneralClientBootstrap class throws an exception.", exception);
                 EventManager.Instance.Dispatch(this, args);
             }
         }
@@ -423,16 +425,34 @@ private GeneralClientBootstrap AddListener<TArgs>(Action<object, TArgs> callback
     }
 
     private void OnMultiDownloadStatistics(object sender, MultiDownloadStatisticsEventArgs e)
-        => EventManager.Instance.Dispatch(sender, e);
+    {
+        var message = GetPacketHash(e.Version);
+        GeneralTracer.Info($"Multi download statistics, {message}[BytesReceived]:{e.BytesReceived} [ProgressPercentage]:{e.ProgressPercentage} [Remaining]:{e.Remaining} [TotalBytesToReceive]:{e.TotalBytesToReceive} [Speed]:{e.Speed}");
+        EventManager.Instance.Dispatch(sender, e);
+    }
 
     private void OnMultiDownloadCompleted(object sender, MultiDownloadCompletedEventArgs e)
-        => EventManager.Instance.Dispatch(sender, e);
+    {
+        var message = GetPacketHash(e.Version);
+        GeneralTracer.Info($"Multi download completed, {message}[IsComplated]:{e.IsComplated}.");
+        EventManager.Instance.Dispatch(sender, e);
+    }
 
     private void OnMultiDownloadError(object sender, MultiDownloadErrorEventArgs e)
-        => EventManager.Instance.Dispatch(sender, e);
+    {
+        var message = GetPacketHash(e.Version);
+        GeneralTracer.Error($"Multi download error {message}.", e.Exception);
+        EventManager.Instance.Dispatch(sender, e);
+    }
 
     private void OnMultiAllDownloadCompleted(object sender, MultiAllDownloadCompletedEventArgs e)
-        => EventManager.Instance.Dispatch(sender, e);
+    {
+        GeneralTracer.Info($"Multi all download completed {e.IsAllDownloadCompleted}.");
+        EventManager.Instance.Dispatch(sender, e);
+    }
+
+    private string GetPacketHash(object version) => 
+        !GeneralTracer.IsTracingEnabled() ? string.Empty : $"[PacketHash]:{(version as VersionInfo).Hash} ";
 
     #endregion Private Methods
 }
diff --git a/src/c#/GeneralUpdate.ClientCore/Strategys/LinuxStrategy.cs b/src/c#/GeneralUpdate.ClientCore/Strategys/LinuxStrategy.cs
@@ -62,6 +62,7 @@ public override async Task ExecuteAsync()
                 catch (Exception e)
                 {
                     status = ReportType.Failure;
+                    GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception.", e);
                     EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
                 }
                 finally
@@ -85,7 +86,7 @@ await VersionService.Report(_configinfo.ReportUrl
         }
         catch (Exception e)
         {
-            GeneralTracer.Error("The ExecuteAsync method in the LinuxStrategy class throws an exception." , e);
+            GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception." , e);
             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
         }
     }
@@ -109,7 +110,7 @@ public override void StartApp()
         }
         catch (Exception e)
         {
-            GeneralTracer.Error("The StartApp method in the LinuxStrategy class throws an exception." , e);
+            GeneralTracer.Error("The StartApp method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception." , e);
             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
         }
         finally
diff --git a/src/c#/GeneralUpdate.ClientCore/Strategys/WindowsStrategy.cs b/src/c#/GeneralUpdate.ClientCore/Strategys/WindowsStrategy.cs
@@ -58,6 +58,7 @@ public override async Task ExecuteAsync()
                 catch (Exception e)
                 {
                     status = ReportType.Failure;
+                    GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception.", e);
                     EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
                 }
                 finally
@@ -81,7 +82,7 @@ await VersionService.Report(_configinfo.ReportUrl
         }
         catch (Exception e)
         {
-            GeneralTracer.Error("The ExecuteAsync method in the WindowsStrategy class throws an exception." , e);
+            GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception." , e);
             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
         }
     }
@@ -104,7 +105,7 @@ public override void StartApp()
         }
         catch (Exception e)
         {
-            GeneralTracer.Error("The StartApp method in the WindowsStrategy class throws an exception." , e);
+            GeneralTracer.Error("The StartApp method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception." , e);
             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
         }
         finally
diff --git a/src/c#/GeneralUpdate.Core/GeneralUpdateBootstrap.cs b/src/c#/GeneralUpdate.Core/GeneralUpdateBootstrap.cs
@@ -150,6 +150,7 @@ private void OnMultiDownloadError(object sender, MultiDownloadErrorEventArgs e)
 
         private void OnMultiAllDownloadCompleted(object sender, MultiAllDownloadCompletedEventArgs e)
         {
+            GeneralTracer.Info($"Multi all download completed {e.IsAllDownloadCompleted}.");
             EventManager.Instance.Dispatch(sender, e);
             ExecuteStrategy();
         }
diff --git a/src/c#/GeneralUpdate.Core/Strategys/WindowsStrategy.cs b/src/c#/GeneralUpdate.Core/Strategys/WindowsStrategy.cs
@@ -67,6 +67,7 @@ public override void Execute()
                         catch (Exception e)
                         {
                             status = ReportType.Failure;
+                            GeneralTracer.Error("The Execute method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);
                             EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
                         }
                         finally
@@ -91,7 +92,7 @@ await VersionService.Report(_configinfo.ReportUrl
                 }
                 catch (Exception e)
                 {
-                    GeneralTracer.Error("The Execute method in the WindowsStrategy class throws an exception.", e);
+                    GeneralTracer.Error("The Execute method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);
                     EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
                 }
             });
@@ -116,7 +117,7 @@ public override void StartApp()
             }
             catch (Exception e)
             {
-                GeneralTracer.Error("The StartApp method in the WindowsStrategy class throws an exception.", e);
+                GeneralTracer.Error("The StartApp method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);
                 EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));
             }
             finally

Original file line number	Diff line number	Diff line change
`@@ -375,6 +375,7 @@ private void CallSmallBowlHome(string processName)`
`375`	`375`	`}`
`376`	`376`	`catch (Exception ex)`
`377`	`377`	`{`
	`378`	`+ GeneralTracer.Error("The CallSmallBowlHome method in the GeneralClientBootstrap class throws an exception.", ex);`
`378`	`379`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(ex, ex.Message));`
`379`	`380`	`}`
`380`	`381`	`}`
`@@ -393,6 +394,7 @@ private void ExecuteCustomOptions()`
`393`	`394`	`{`
`394`	`395`	`var exception = new Exception($"{nameof(option)}Execution failure!");`
`395`	`396`	`var args = new ExceptionEventArgs(exception, exception.Message);`
	`397`	`+ GeneralTracer.Error("The ExecuteCustomOptions method in the GeneralClientBootstrap class throws an exception.", exception);`
`396`	`398`	`EventManager.Instance.Dispatch(this, args);`
`397`	`399`	`}`
`398`	`400`	`}`
`@@ -423,16 +425,34 @@ private GeneralClientBootstrap AddListener<TArgs>(Action<object, TArgs> callback`
`423`	`425`	`}`
`424`	`426`
`425`	`427`	`private void OnMultiDownloadStatistics(object sender, MultiDownloadStatisticsEventArgs e)`
`426`		`- => EventManager.Instance.Dispatch(sender, e);`
	`428`	`+ {`
	`429`	`+ var message = GetPacketHash(e.Version);`
	`430`	`+ GeneralTracer.Info($"Multi download statistics, {message}[BytesReceived]:{e.BytesReceived} [ProgressPercentage]:{e.ProgressPercentage} [Remaining]:{e.Remaining} [TotalBytesToReceive]:{e.TotalBytesToReceive} [Speed]:{e.Speed}");`
	`431`	`+ EventManager.Instance.Dispatch(sender, e);`
	`432`	`+ }`
`427`	`433`
`428`	`434`	`private void OnMultiDownloadCompleted(object sender, MultiDownloadCompletedEventArgs e)`
`429`		`- => EventManager.Instance.Dispatch(sender, e);`
	`435`	`+ {`
	`436`	`+ var message = GetPacketHash(e.Version);`
	`437`	`+ GeneralTracer.Info($"Multi download completed, {message}[IsComplated]:{e.IsComplated}.");`
	`438`	`+ EventManager.Instance.Dispatch(sender, e);`
	`439`	`+ }`
`430`	`440`
`431`	`441`	`private void OnMultiDownloadError(object sender, MultiDownloadErrorEventArgs e)`
`432`		`- => EventManager.Instance.Dispatch(sender, e);`
	`442`	`+ {`
	`443`	`+ var message = GetPacketHash(e.Version);`
	`444`	`+ GeneralTracer.Error($"Multi download error {message}.", e.Exception);`
	`445`	`+ EventManager.Instance.Dispatch(sender, e);`
	`446`	`+ }`
`433`	`447`
`434`	`448`	`private void OnMultiAllDownloadCompleted(object sender, MultiAllDownloadCompletedEventArgs e)`
`435`		`- => EventManager.Instance.Dispatch(sender, e);`
	`449`	`+ {`
	`450`	`+ GeneralTracer.Info($"Multi all download completed {e.IsAllDownloadCompleted}.");`
	`451`	`+ EventManager.Instance.Dispatch(sender, e);`
	`452`	`+ }`
	`453`	`+`
	`454`	`+ private string GetPacketHash(object version) =>`
	`455`	`+ !GeneralTracer.IsTracingEnabled() ? string.Empty : $"[PacketHash]:{(version as VersionInfo).Hash} ";`
`436`	`456`
`437`	`457`	`#endregion Private Methods`
`438`	`458`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ public override async Task ExecuteAsync()`
`62`	`62`	`catch (Exception e)`
`63`	`63`	`{`
`64`	`64`	`status = ReportType.Failure;`
	`65`	`+ GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception.", e);`
`65`	`66`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`66`	`67`	`}`
`67`	`68`	`finally`
`@@ -85,7 +86,7 @@ await VersionService.Report(_configinfo.ReportUrl`
`85`	`86`	`}`
`86`	`87`	`catch (Exception e)`
`87`	`88`	`{`
`88`		`- GeneralTracer.Error("The ExecuteAsync method in the LinuxStrategy class throws an exception." , e);`
	`89`	`+ GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception." , e);`
`89`	`90`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`90`	`91`	`}`
`91`	`92`	`}`
`@@ -109,7 +110,7 @@ public override void StartApp()`
`109`	`110`	`}`
`110`	`111`	`catch (Exception e)`
`111`	`112`	`{`
`112`		`- GeneralTracer.Error("The StartApp method in the LinuxStrategy class throws an exception." , e);`
	`113`	`+ GeneralTracer.Error("The StartApp method in the GeneralUpdate.ClientCore.LinuxStrategy class throws an exception." , e);`
`113`	`114`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`114`	`115`	`}`
`115`	`116`	`finally`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ public override async Task ExecuteAsync()`
`58`	`58`	`catch (Exception e)`
`59`	`59`	`{`
`60`	`60`	`status = ReportType.Failure;`
	`61`	`+ GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception.", e);`
`61`	`62`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`62`	`63`	`}`
`63`	`64`	`finally`
`@@ -81,7 +82,7 @@ await VersionService.Report(_configinfo.ReportUrl`
`81`	`82`	`}`
`82`	`83`	`catch (Exception e)`
`83`	`84`	`{`
`84`		`- GeneralTracer.Error("The ExecuteAsync method in the WindowsStrategy class throws an exception." , e);`
	`85`	`+ GeneralTracer.Error("The ExecuteAsync method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception." , e);`
`85`	`86`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`86`	`87`	`}`
`87`	`88`	`}`
`@@ -104,7 +105,7 @@ public override void StartApp()`
`104`	`105`	`}`
`105`	`106`	`catch (Exception e)`
`106`	`107`	`{`
`107`		`- GeneralTracer.Error("The StartApp method in the WindowsStrategy class throws an exception." , e);`
	`108`	`+ GeneralTracer.Error("The StartApp method in the GeneralUpdate.ClientCore.WindowsStrategy class throws an exception." , e);`
`108`	`109`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`109`	`110`	`}`
`110`	`111`	`finally`
Original file line number	Diff line number	Diff line change
`@@ -150,6 +150,7 @@ private void OnMultiDownloadError(object sender, MultiDownloadErrorEventArgs e)`
`150`	`150`
`151`	`151`	`private void OnMultiAllDownloadCompleted(object sender, MultiAllDownloadCompletedEventArgs e)`
`152`	`152`	`{`
	`153`	`+ GeneralTracer.Info($"Multi all download completed {e.IsAllDownloadCompleted}.");`
`153`	`154`	`EventManager.Instance.Dispatch(sender, e);`
`154`	`155`	`ExecuteStrategy();`
`155`	`156`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ public override void Execute()`
`67`	`67`	`catch (Exception e)`
`68`	`68`	`{`
`69`	`69`	`status = ReportType.Failure;`
	`70`	`+ GeneralTracer.Error("The Execute method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);`
`70`	`71`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`71`	`72`	`}`
`72`	`73`	`finally`
`@@ -91,7 +92,7 @@ await VersionService.Report(_configinfo.ReportUrl`
`91`	`92`	`}`
`92`	`93`	`catch (Exception e)`
`93`	`94`	`{`
`94`		`- GeneralTracer.Error("The Execute method in the WindowsStrategy class throws an exception.", e);`
	`95`	`+ GeneralTracer.Error("The Execute method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);`
`95`	`96`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`96`	`97`	`}`
`97`	`98`	`});`
`@@ -116,7 +117,7 @@ public override void StartApp()`
`116`	`117`	`}`
`117`	`118`	`catch (Exception e)`
`118`	`119`	`{`
`119`		`- GeneralTracer.Error("The StartApp method in the WindowsStrategy class throws an exception.", e);`
	`120`	`+ GeneralTracer.Error("The StartApp method in the GeneralUpdate.Core.WindowsStrategy class throws an exception.", e);`
`120`	`121`	`EventManager.Instance.Dispatch(this, new ExceptionEventArgs(e, e.Message));`
`121`	`122`	`}`
`122`	`123`	`finally`