-
-
Notifications
You must be signed in to change notification settings - Fork 205
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Apply WinUI 3 exception handler in Sentry core (#1863)
- Loading branch information
1 parent
9f98ec1
commit 900697b
Showing
6 changed files
with
156 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
135 changes: 135 additions & 0 deletions
135
src/Sentry/Integrations/WinUIUnhandledExceptionIntegration.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| #if NET5_0_OR_GREATER | ||
| using System; | ||
| using System.Linq; | ||
| using System.Reflection; | ||
| using System.Runtime.InteropServices; | ||
| using Sentry.Extensibility; | ||
|
|
||
| namespace Sentry.Integrations | ||
| { | ||
| // This integration hooks unhandled exceptions in WinUI 3. | ||
| // The primary hook is Microsoft.UI.Xaml.Application.Current.UnhandledException | ||
| // | ||
| // There are some quirks to be aware of: | ||
| // | ||
| // - By default, important details (message, stack trace, etc.) are stripped away. | ||
| // We can work around this by catching first-chance exceptions. | ||
| // See: https://github.com/microsoft/microsoft-ui-xaml/issues/7160 | ||
| // | ||
| // - Exceptions from background threads are not caught here. | ||
| // However, they are caught by System.AppDomain.CurrentDomain.UnhandledException, | ||
| // which we already hook in our AppDomainUnhandledExceptionIntegration | ||
| // See: https://github.com/microsoft/microsoft-ui-xaml/issues/5221 | ||
| // | ||
| // Note that we use reflection in this integration to get at WinUI code. | ||
| // If we ever add a Windows platform target (net6.0-windows, etc.), we could refactor to avoid reflection. | ||
| // | ||
| // This integration is for WinUI 3. It does NOT work for UWP (WinUI 2). | ||
| // For UWP, the calling application will need to hook the event handler. | ||
| // See https://docs.sentry.io/platforms/dotnet/guides/uwp/ | ||
| // (We can't do it automatically without a separate UWP class library, | ||
| // due to a security exception when attempting to attach the event dynamically.) | ||
|
|
||
| internal class WinUIUnhandledExceptionIntegration : ISdkIntegration | ||
| { | ||
| private static readonly byte[] WinUIPublicKeyToken = Convert.FromHexString("de31ebe4ad15742b"); | ||
| private static readonly Assembly? WinUIAssembly = GetWinUIAssembly(); | ||
|
|
||
| private Exception? _lastFirstChanceException; | ||
| private IHub _hub = null!; | ||
| private SentryOptions _options = null!; | ||
|
|
||
| public static bool IsApplicable => WinUIAssembly != null; | ||
|
|
||
| public void Register(IHub hub, SentryOptions options) | ||
| { | ||
| if (!IsApplicable) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| _hub = hub; | ||
| _options = options; | ||
|
|
||
| // Hook the main event handler | ||
| AttachEventHandler(); | ||
|
|
||
| // First part of workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/7160 | ||
| AppDomain.CurrentDomain.FirstChanceException += (_, e) => _lastFirstChanceException = e.Exception; | ||
| } | ||
|
|
||
| private static Assembly? GetWinUIAssembly() | ||
| { | ||
| if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| { | ||
| // Not running on Windows | ||
| return null; | ||
| } | ||
|
|
||
| // Attempt to locate the Microsoft.WinUI assembly from the AppDomain | ||
| var assemblies = AppDomain.CurrentDomain.GetAssemblies(); | ||
| return Array.Find(assemblies, x => | ||
| { | ||
| // check by name and public key token | ||
| var assemblyName = x.GetName(); | ||
| return assemblyName.Name == "Microsoft.WinUI" && | ||
| assemblyName.GetPublicKeyToken()?.SequenceEqual(WinUIPublicKeyToken) is true; | ||
| }); | ||
| } | ||
|
|
||
| private void AttachEventHandler() | ||
| { | ||
| try | ||
| { | ||
| // Reflection equivalent of: | ||
| // Microsoft.UI.Xaml.Application.Current.UnhandledException += WinUIUnhandledExceptionHandler; | ||
| // | ||
| EventHandler handler = WinUIUnhandledExceptionHandler!; | ||
| var applicationType = WinUIAssembly!.GetType("Microsoft.UI.Xaml.Application")!; | ||
| var application = applicationType.GetProperty("Current")!.GetValue(null); | ||
| var eventInfo = applicationType.GetEvent("UnhandledException")!; | ||
| var typedHandler = Delegate.CreateDelegate(eventInfo.EventHandlerType!, handler.Target, handler.Method); | ||
| eventInfo.AddEventHandler(application, typedHandler); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| _options.LogError("Could not attach WinUIUnhandledExceptionHandler.", ex); | ||
| } | ||
| } | ||
|
|
||
| private void WinUIUnhandledExceptionHandler(object sender, object e) | ||
| { | ||
| bool handled; | ||
| Exception exception; | ||
| try | ||
| { | ||
| var eventArgsType = e.GetType(); | ||
| handled = (bool)eventArgsType.GetProperty("Handled")!.GetValue(e)!; | ||
| exception = (Exception)eventArgsType.GetProperty("Exception")!.GetValue(e)!; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| _options.LogError("Could not get exception details in WinUIUnhandledExceptionHandler.", ex); | ||
| return; | ||
| } | ||
|
|
||
| // Second part of workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/7160 | ||
| if (exception.StackTrace is null) | ||
| { | ||
| exception = _lastFirstChanceException!; | ||
| } | ||
|
|
||
| // Set some useful data and capture the exception | ||
| exception.Data[Protocol.Mechanism.HandledKey] = handled; | ||
| exception.Data[Protocol.Mechanism.MechanismKey] = "Microsoft.UI.Xaml.UnhandledException"; | ||
| _hub.CaptureException(exception); | ||
|
|
||
| if (!handled) | ||
| { | ||
| // We're crashing, so flush events to Sentry right away | ||
| _hub.FlushAsync(_options.ShutdownTimeout).GetAwaiter().GetResult(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters