Properly flush unhandled/inner exceptions into log file.

Soapwood · Jul 30, 2024 · 49231fd · 49231fd
1 parent c7e0779
commit 49231fd
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 2 deletions.
diff --git a/VXMusicDesktop/App.xaml.cs b/VXMusicDesktop/App.xaml.cs
@@ -54,6 +54,10 @@ public App() : base()
 
             ApplicationVersion = Assembly.GetExecutingAssembly().GetName().Version;
 
+            // Subscribe to global exception handlers
+            AppDomain.CurrentDomain.UnhandledException += UnhandledExceptionHandler;
+            this.DispatcherUnhandledException += DispatcherUnhandledExceptionHandler;
+
             IConfiguration configuration = new ConfigurationBuilder()
                 .SetBasePath(Directory.GetCurrentDirectory())
                 .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
@@ -174,6 +178,39 @@ public static void ConfigureServices()
             Logger = ServiceProvider.GetRequiredService<ILogger<App>>();
         }
 
+        private static void UnhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e)
+        {
+            if (e.ExceptionObject is Exception ex)
+            {
+                LogException(ex, "UNHANDLED EXCEPTION OCCURRED!");
+            }
+            else
+            {
+                Logger.LogError("UNHANDLED EXCEPTION OCCURRED!");
+            }
+
+            // Optionally flush the logs before exit
+            if (Logger is IDisposable disposableLogger)
+            {
+                disposableLogger.Dispose();
+            }
+        }
+
+        private void DispatcherUnhandledExceptionHandler(object sender, System.Windows.Threading.DispatcherUnhandledExceptionEventArgs e)
+        {
+            LogException(e.Exception, "DISPATCHER UNHANDLED EXCEPTION OCCURRED!");
+            e.Handled = true;
+        }
+
+        private static void LogException(Exception ex, string message)
+        {
+            Logger.LogError(ex, message);
+            if (ex.InnerException != null)
+            {
+                LogException(ex.InnerException, "INNER EXCEPTION:");
+            }
+        }
+
         void VXMusicOverlay_Exit(object sender, ExitEventArgs e)
         {
             try
@@ -198,6 +235,7 @@ void VXMusicOverlay_Exit(object sender, ExitEventArgs e)
         }
         protected override void OnExit(ExitEventArgs e)
         {
+            NLog.LogManager.Shutdown();
             base.OnExit(e);
         }
     }

diff --git a/VXMusicDesktop/NLog.config b/VXMusicDesktop/NLog.config
@@ -4,7 +4,7 @@
       autoReload="true"
       throwExceptions="false">
 
-	<variable name="defaultLogFormat" value="${time} [${level:uppercase=true}] ${logger} | ${message}"/>
+	<variable name="defaultLogFormat" value="${time} [${level:uppercase=true}] ${logger} | ${message} ${exception:format=ToString,StackTrace:innerFormat=ToString,StackTrace}"/>
 
 	<!-- Define the targets where log messages will be sent -->
 	<targets>

diff --git a/VXMusicDesktop/VXMusicDesktop.csproj b/VXMusicDesktop/VXMusicDesktop.csproj
@@ -9,7 +9,7 @@
     <PackageIcon>VXLogo.png</PackageIcon>
     <ApplicationIcon>Images\VXLogoIcon.ico</ApplicationIcon>
     <RunPostBuildEvent>Always</RunPostBuildEvent>
-    <Version>0.6.4.21</Version>
+    <Version>0.6.4.22</Version>
     <SatelliteResourceLanguages>en</SatelliteResourceLanguages>
     <Title>VXMusicDesktop</Title>
     <Authors>VirtualXtensions</Authors>