Skip to content

Commit

Permalink
Improve reporting and displaying of unhandled exceptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jvyden
jvyden committed Sep 8, 2024
1 parent 957d922 commit cc89f92
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 53 deletions.
6 changes: 6 additions & 0 deletions .idea/.idea.Refresher/.idea/git_toolbox_blame.xml
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

184 changes: 131 additions & 53 deletions Refresher/Program.cs
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
using System.Diagnostics;
using System.Reflection;
using CommandLine;
using Eto.Forms;
using Refresher.CLI;
using Refresher.Patching;
using Refresher.UI;
using Sentry;

namespace Refresher;

Expand Down Expand Up @@ -59,60 +58,39 @@ public static void Main(string[] args)
if (args.Length > 0)
{
Log("Launching in CLI mode");

AppDomain.CurrentDomain.UnhandledException += (_, eventArgs) =>
{
Exception ex = (Exception)eventArgs.ExceptionObject;
ReportUnhandledException(ex, false);
};

Parser.Default.ParseArguments<CommandLineOptions>(args)
.WithParsed(CLI.CommandLine.Run);
}
else
{
Log("Launching in GUI mode");
App = new Application();
try
{
App = new Application();
}
catch (Exception e)
{
ReportUnhandledException(e, false);
Environment.Exit(-1);
}

App.UnhandledException += (_, eventArgs) =>
{
Exception ex = (Exception)eventArgs.ExceptionObject;

if (ex is TypeInitializationException { TypeName: "SCEToolSharp.LibSceToolSharp" })
{
const string msg = """
libscetool, a critical component of Refresher, failed to initialize.
Please ensure you are using the latest version of Refresher, and that you've picked the correct version for your architecture.
""";

MessageBox.Show(msg, "Critical Error");
return;
}

if (ex is DllNotFoundException)
{
string msg = $"""
Refresher is apparently missing critical components that are required to run.
We believe that this is a problem with your OS. If you find out what exactly this is, please let us know on GitHub or Discord.
The exception details are printed below:
{ex}
""";

Console.WriteLine(msg); // print the error to stdout
try
{
MessageBox.Show(msg, "Critical Error");
}
catch
{
Console.ReadKey(); // try to pause the command window to show the error if we cant show the messagebox
}
return;
}

SentrySdk.CaptureException(ex);
SentrySdk.Flush();
MessageBox.Show($"""
There was an unhandled error in Refresher.
This has been automatically reported to us. The exception details has been displayed for further debugging:
{ex}
""",
"Critical Error");

ReportUnhandledException(ex, true);
};

AppDomain.CurrentDomain.UnhandledException += (_, eventArgs) =>
{
Exception ex = (Exception)eventArgs.ExceptionObject;
ReportUnhandledException(ex, true);
};

try
Expand All @@ -123,15 +101,115 @@ There was an unhandled error in Refresher.
{
SentrySdk.CaptureException(ex);
SentrySdk.Flush();
MessageBox.Show($"""
There was an unhandled error in Refresher.
This has been automatically reported to us. The exception details has been displayed for further debugging:
{ex}
""", "Critical Error");
TryShowException(ex, true);
}
App.Dispose();
SentrySdk.Flush();
}
}

/// <summary>
/// Try our best to report an exception both to Sentry and to the user before crashing.
/// </summary>
/// <param name="ex"></param>
/// <param name="gui">Whether we're in GUI mode</param>
private static void ReportUnhandledException(Exception ex, bool gui)
{
// handle a bunch of known cases first
switch (ex)
{
case TargetInvocationException invocationException:
{
// unwrap invocation exceptions
ReportUnhandledException(invocationException.InnerException, gui);
return;
}
case TypeInitializationException { TypeName: "SCEToolSharp.LibSceToolSharp" }:
{
const string msg = """
libscetool, a critical component of Refresher, failed to initialize.
Please ensure you are using the latest version of Refresher, and that you've picked the correct version for your architecture.
""";

TryShowMessage(msg, true);
return;
}
case DllNotFoundException:
{
string msg = $"""
Refresher is apparently missing critical components that are required to run.
We believe that this is a problem with your OS. If you find out what exactly this is, please let us know on GitHub or Discord.
The exception details are printed below:
{ex}
""";
TryShowMessage(msg, gui);
return;
}
case InvalidOperationException operationException:
{
// "System.InvalidOperationException: Could not detect platform. Are you missing a platform assembly?"
// at Eto.Platform.get_Detect()
if (!operationException.Message.Contains("platform"))
break;

string msg =
$"""
Refresher was unable to load the GUI backend for your platform. It's possible Refresher doesn't support this platform or you downloaded the wrong build.
The exception details are printed below:
{ex}
""";
TryShowMessage(msg, gui);
return;
}
}

// if we got here, we don't recognize the exception, so report it
SentrySdk.CaptureException(ex);
SentrySdk.Flush();

TryShowException(ex, gui);
}

/// <summary>
/// Try our best to display a critical crash message to the user.
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="gui">Whether we're in GUI mode</param>
private static void TryShowMessage(string message, bool gui)
{
// always print the error to stdout, no matter what.
// this is pretty much guaranteed to always work
Console.WriteLine("\n=====Critical Error=====");
Console.WriteLine(message);
Console.WriteLine("========================\n");

if (!gui) return;
try
{
MessageBox.Show(message, "Critical Error");
}
catch
{
// the reason we might be here is *because* we can't load the GUI.
// to handle that case, we show the error in the console instead.
//
// on windows, the cmd window might instantly close and make the error unreadable,
// so let's hold the input buffer open
Console.WriteLine("Press any key to exit...");
Console.ReadKey();
}
}

private static void TryShowException(Exception ex, bool gui)
{
string msg = $"""
There was an unhandled error in Refresher.
This has been automatically reported to us. The exception details has been displayed for further debugging:
{ex}
""";
TryShowMessage(msg, gui);
}
}

0 comments on commit cc89f92

Please sign in to comment.