boost(ErrorReporting): Add proper error reporting

using Sentry.

Fixes #546

Author: Belphemur

SoundSwitch/Framework/Logger/Configuration/LoggerConfigurator.cs

@@ -2,8 +2,10 @@
 using System.Diagnostics;
 using System.IO;
 using Serilog;
+using Serilog.Events;
 using Serilog.Exceptions;
 using SoundSwitch.Framework.Logger.Enricher;
+using SoundSwitch.Util;
 
 namespace SoundSwitch.Framework.Logger.Configuration
 {
@@ -24,6 +26,14 @@ public static void ConfigureLogger()
                              rollingInterval: RollingInterval.Day, retainedFileCountLimit: 3,
                              flushToDiskInterval: TimeSpan.FromMinutes(10),
                              outputTemplate: "[{Timestamp:HH:mm:ss.fff} {Level:u3}] {Message} (at {Caller}){NewLine}{Exception}")
+                         .WriteTo.Sentry(o =>
+                         {
+                             o.InitializeSdk = false;
+                             o.Dsn = "https://[email protected]/5755327";
+                             o.MinimumBreadcrumbLevel = LogEventLevel.Debug;
+                             o.MinimumEventLevel = LogEventLevel.Error;
+                             o.Environment = AssemblyUtils.GetReleaseState().ToString();
+                         })
                          .CreateLogger();
             var listener = new global::SerilogTraceListener.SerilogTraceListener();
             Trace.Listeners.Add(listener);

SoundSwitch/Program.cs

@@ -15,21 +15,21 @@
 
 using System;
 using System.Diagnostics;
-using System.IO;
-using System.IO.Compression;
 using System.Runtime.ExceptionServices;
 using System.Runtime.InteropServices;
 using System.Threading;
 using System.Windows.Forms;
+using Sentry;
 using Serilog;
 using SoundSwitch.Framework;
+using SoundSwitch.Framework.Configuration;
 using SoundSwitch.Framework.Logger.Configuration;
-using SoundSwitch.Framework.Minidump;
 using SoundSwitch.Framework.NotificationManager;
 using SoundSwitch.Framework.WinApi;
 using SoundSwitch.Localization.Factory;
 using SoundSwitch.Model;
 using SoundSwitch.Util;
+using SoundSwitch.Util.Url;
 
 namespace SoundSwitch
 {
@@ -42,13 +42,15 @@ internal static class Program
         [STAThread]
         private static void Main()
         {
+            using var _ = SentrySdk.Init(options =>
+            {
+                options.Dsn = "https://[email protected]/5755327";
+                options.Environment = AssemblyUtils.GetReleaseState().ToString();
+            });
             InitializeLogger();
             Log.Information("Application Starts");
 #if !DEBUG
-            AppDomain.CurrentDomain.UnhandledException += (sender, args) =>
-            {
-                HandleException((Exception) args.ExceptionObject);
-            };
+            AppDomain.CurrentDomain.UnhandledException += (sender, args) => { HandleException((Exception) args.ExceptionObject); };
 
             Log.Information("Set Exception Handler");
             Application.ThreadException += Application_ThreadException;
@@ -134,7 +136,6 @@ private static void Main()
             WindowsAPIAdapter.Stop();
             MMNotificationClient.Instance.Dispose();
             Log.CloseAndFlush();
-
         }
 
         /// <summary>
@@ -147,6 +148,8 @@ private static void InitializeLogger()
                 $"{Application.ProductName}  {AssemblyUtils.GetReleaseState()} ({Application.ProductVersion})");
             Log.Information($"OS: {Environment.OSVersion}");
             Log.Information($"Framework: {Environment.Version}");
+
+            SentrySdk.ConfigureScope(scope => { scope.AddAttachment(AppConfigs.Configuration.FileLocation); });
         }
 
         /// <summary>
@@ -174,8 +177,8 @@ private static void HandleException(Exception exception)
         {
             if (exception == null)
                 return;
-            var zipFile = Path.Combine(ApplicationPath.AppData,
-                $"{Application.ProductName}-crashlog-{DateTime.UtcNow.Date.Day}_{DateTime.UtcNow.Date.Month}_{DateTime.UtcNow.Date.Year}.zip");
+            var eventId = SentrySdk.CaptureException(exception);
+
             var exceptionMessage = exception.Message;
             if (exception.InnerException != null)
             {
@@ -187,39 +190,15 @@ private static void HandleException(Exception exception)
 
 {exceptionMessage}
 
-Do you want to save a log of the error that occurred?
-This could be useful to fix bugs. Please post this file in the issues section
-File Location: {zipFile}";
+Would you like to share more information with the developers?";
             var result = MessageBox.Show(message, $@"{Application.ProductName} crashed...", MessageBoxButtons.YesNo,
                 MessageBoxIcon.Error);
 
-            if (result == DialogResult.Yes)
-            {
-                using (new HourGlass())
-                {
-                    var fileName = Path.Combine(ApplicationPath.Default, Environment.MachineName + ".dmp");
-                    using (
-                        var fs = new FileStream(fileName, FileMode.Create, FileAccess.ReadWrite,
-                            FileShare.Write))
-                    {
-                        MiniDump.Write(fs.SafeFileHandle,
-                            MiniDump.Option.Normal | MiniDump.Option.WithThreadInfo | MiniDump.Option.WithHandleData |
-                            MiniDump.Option.WithDataSegs, MiniDump.ExceptionInfo.Present);
-                    }
-
-                    Log.Fatal(exception, "Exception Occurred ");
-
-                    if (File.Exists(zipFile))
-                    {
-                        File.Delete(zipFile);
-                    }
-
-                    Log.CloseAndFlush();
-
-                    ZipFile.CreateFromDirectory(ApplicationPath.Default, zipFile);
-                }
+            if (result != DialogResult.Yes) return;
 
-                Process.Start("explorer.exe", "/select," + @zipFile);
+            using (new HourGlass())
+            {
+                BrowserUtil.OpenUrl($"https://soundswitch.aaflalo.me/#sentry?eventId={eventId}");
             }
         }
     }

SoundSwitch/SoundSwitch.csproj

@@ -39,6 +39,7 @@
         <PackageReference Include="NAudio" Version="2.0.0" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
         <PackageReference Include="RailSharp" Version="1.0.0" />
+        <PackageReference Include="Sentry.Serilog" Version="3.3.4" />
         <PackageReference Include="Serilog" Version="2.10.0" />
         <PackageReference Include="Serilog.Enrichers.Environment" Version="2.1.3" />
         <PackageReference Include="Serilog.Enrichers.Thread" Version="3.1.0" />

SoundSwitch/Util/AssemblyUtils.cs

@@ -22,7 +22,8 @@ public static class AssemblyUtils
         public enum ReleaseState
         {
             Stable,
-            Beta
+            Beta,
+            Debug
         }
 
         /// <summary>
@@ -43,7 +44,11 @@ public static AssemblyConfigurationAttribute GetAssemblyConfigurationAttribute()
         /// <returns></returns>
         public static ReleaseState GetReleaseState()
         {
+#if DEBUG
+            return ReleaseState.Debug;
+#else
             return GetAssemblyConfigurationAttribute().Configuration == "Beta" ? ReleaseState.Beta : ReleaseState.Stable;
+#endif
         }
     }
 }