Update unobserved task exception integration

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Simplify API for flushing events ([#2030](https://github.com/getsentry/sentry-dotnet/pull/2030))
 
+### Fixes
+
+- Update unobserved task exception integration ([#2034](https://github.com/getsentry/sentry-dotnet/pull/2034))
+
 ## 3.23.1
 
 ### Fixes

src/Sentry/Integrations/TaskUnobservedTaskExceptionIntegration.cs → src/Sentry/Integrations/UnobservedTaskExceptionIntegration.cs

@@ -8,12 +8,12 @@
 
 namespace Sentry.Integrations
 {
-    internal class TaskUnobservedTaskExceptionIntegration : ISdkIntegration
+    internal class UnobservedTaskExceptionIntegration : ISdkIntegration
     {
         private readonly IAppDomain _appDomain;
-        private IHub? _hub;
+        private IHub _hub = null!;
 
-        internal TaskUnobservedTaskExceptionIntegration(IAppDomain? appDomain = null)
+        internal UnobservedTaskExceptionIntegration(IAppDomain? appDomain = null)
             => _appDomain = appDomain ?? AppDomainAdapter.Instance;
 
         public void Register(IHub hub, SentryOptions _)
@@ -22,19 +22,24 @@ public void Register(IHub hub, SentryOptions _)
             _appDomain.UnobservedTaskException += Handle;
         }
 
-        // Internal for testability
 #if !NET6_0_OR_GREATER
         [HandleProcessCorruptedStateExceptions]
 #endif
         [SecurityCritical]
         internal void Handle(object? sender, UnobservedTaskExceptionEventArgs e)
         {
-            if (e.Exception is { } ex)
-            {
-                ex.Data[Mechanism.HandledKey] = false;
-                ex.Data[Mechanism.MechanismKey] = "UnobservedTaskException";
-                _ = _hub?.CaptureException(ex);
-            }
+            // The exception will never be null in any runtime.
+            // The annotation was corrected in .NET 5
+            // See: https://github.com/dotnet/runtime/issues/32454
+
+#if NET5_0_OR_GREATER
+            var ex = e.Exception;
+#else
+            var ex = e.Exception!;
+#endif
+            ex.Data[Mechanism.HandledKey] = false;
+            ex.Data[Mechanism.MechanismKey] = "UnobservedTaskException";
+            _hub.CaptureException(ex);
         }
     }
 }

src/Sentry/SentryOptions.cs

@@ -804,7 +804,7 @@ public SentryOptions()
                 new AutoSessionTrackingIntegration(),
                 new AppDomainUnhandledExceptionIntegration(),
                 new AppDomainProcessExitIntegration(),
-                new TaskUnobservedTaskExceptionIntegration(),
+                new UnobservedTaskExceptionIntegration(),
 #if NETFRAMEWORK
                 new NetFxInstallationsIntegration(),
 #endif

src/Sentry/SentryOptionsExtensions.cs

@@ -55,8 +55,16 @@ public static void DisableDiagnosticSourceIntegration(this SentryOptions options
         /// Disables the capture of errors through <see cref="TaskScheduler.UnobservedTaskException"/>.
         /// </summary>
         /// <param name="options">The SentryOptions to remove the integration from.</param>
+        [Obsolete("Method has been renamed to DisableUnobservedTaskExceptionCapture.  Please update usage.")]
         public static void DisableTaskUnobservedTaskExceptionCapture(this SentryOptions options) =>
-            options.RemoveIntegration<TaskUnobservedTaskExceptionIntegration>();
+            options.DisableUnobservedTaskExceptionCapture();
+
+        /// <summary>
+        /// Disables the capture of errors through <see cref="TaskScheduler.UnobservedTaskException"/>.
+        /// </summary>
+        /// <param name="options">The SentryOptions to remove the integration from.</param>
+        public static void DisableUnobservedTaskExceptionCapture(this SentryOptions options) =>
+            options.RemoveIntegration<UnobservedTaskExceptionIntegration>();
 
 #if NETFRAMEWORK
         /// <summary>

test/Sentry.Tests/ApiApprovalTests.Run.Core3_1.verified.txt

@@ -605,7 +605,10 @@ namespace Sentry
         public static void DisableAppDomainUnhandledExceptionCapture(this Sentry.SentryOptions options) { }
         public static void DisableDiagnosticSourceIntegration(this Sentry.SentryOptions options) { }
         public static void DisableDuplicateEventDetection(this Sentry.SentryOptions options) { }
+        [System.Obsolete("Method has been renamed to DisableUnobservedTaskExceptionCapture.  Please update " +
+            "usage.")]
         public static void DisableTaskUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
+        public static void DisableUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventProcessor> GetAllEventProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventExceptionProcessor> GetAllExceptionProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryTransactionProcessor> GetAllTransactionProcessors(this Sentry.SentryOptions options) { }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet4_8.verified.txt

@@ -604,7 +604,10 @@ namespace Sentry
         public static void DisableAppDomainUnhandledExceptionCapture(this Sentry.SentryOptions options) { }
         public static void DisableDuplicateEventDetection(this Sentry.SentryOptions options) { }
         public static void DisableNetFxInstallationsIntegration(this Sentry.SentryOptions options) { }
+        [System.Obsolete("Method has been renamed to DisableUnobservedTaskExceptionCapture.  Please update " +
+            "usage.")]
         public static void DisableTaskUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
+        public static void DisableUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventProcessor> GetAllEventProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventExceptionProcessor> GetAllExceptionProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryTransactionProcessor> GetAllTransactionProcessors(this Sentry.SentryOptions options) { }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt

@@ -605,7 +605,10 @@ namespace Sentry
         public static void DisableAppDomainUnhandledExceptionCapture(this Sentry.SentryOptions options) { }
         public static void DisableDiagnosticSourceIntegration(this Sentry.SentryOptions options) { }
         public static void DisableDuplicateEventDetection(this Sentry.SentryOptions options) { }
+        [System.Obsolete("Method has been renamed to DisableUnobservedTaskExceptionCapture.  Please update " +
+            "usage.")]
         public static void DisableTaskUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
+        public static void DisableUnobservedTaskExceptionCapture(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventProcessor> GetAllEventProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryEventExceptionProcessor> GetAllExceptionProcessors(this Sentry.SentryOptions options) { }
         public static System.Collections.Generic.IEnumerable<Sentry.Extensibility.ISentryTransactionProcessor> GetAllTransactionProcessors(this Sentry.SentryOptions options) { }

test/Sentry.Tests/SentryOptionsExtensionsTests.cs

@@ -37,11 +37,11 @@ public void DisableAppDomainUnhandledExceptionCapture_RemovesAppDomainUnhandledE
     }
 
     [Fact]
-    public void DisableTaskUnobservedTaskExceptionCapture_TaskUnobservedTaskExceptionIntegration()
+    public void DisableTaskUnobservedTaskExceptionCapture_UnobservedTaskExceptionIntegration()
     {
-        Sut.DisableTaskUnobservedTaskExceptionCapture();
+        Sut.DisableUnobservedTaskExceptionCapture();
         Assert.DoesNotContain(Sut.Integrations!,
-            p => p.GetType() == typeof(TaskUnobservedTaskExceptionIntegration));
+            p => p.GetType() == typeof(UnobservedTaskExceptionIntegration));
     }
 
     [Fact]
@@ -291,7 +291,7 @@ public void Integrations_Includes_AppDomainProcessExitIntegration()
     [Fact]
     public void Integrations_Includes_TaskUnobservedTaskExceptionIntegration()
     {
-        Assert.Contains(Sut.Integrations!, i => i.GetType() == typeof(TaskUnobservedTaskExceptionIntegration));
+        Assert.Contains(Sut.Integrations!, i => i.GetType() == typeof(UnobservedTaskExceptionIntegration));
     }
 
     [Theory]

test/Sentry.Tests/TaskUnobservedTaskExceptionIntegrationTests.cs → test/Sentry.Tests/UnobservedTaskExceptionIntegrationTests.cs

@@ -4,7 +4,7 @@
 
 namespace Sentry.Tests;
 
-public class TaskUnobservedTaskExceptionIntegrationTests
+public class UnobservedTaskExceptionIntegrationTests
 {
     private class Fixture
     {
@@ -13,7 +13,7 @@ private class Fixture
 
         public Fixture() => Hub.IsEnabled.Returns(true);
 
-        public TaskUnobservedTaskExceptionIntegration GetSut()
+        public UnobservedTaskExceptionIntegration GetSut()
             => new(AppDomain);
     }
 
@@ -64,17 +64,6 @@ public void Handle_UnobservedTaskException_CaptureEvent()
     }
 #endif
 
-    [Fact]
-    public void Handle_NoException_NoCaptureEvent()
-    {
-        var sut = _fixture.GetSut();
-        sut.Register(_fixture.Hub, SentryOptions);
-
-        sut.Handle(this, new UnobservedTaskExceptionEventArgs(null));
-
-        _ = _fixture.Hub.DidNotReceive().CaptureEvent(Arg.Any<SentryEvent>());
-    }
-
     [Fact]
     public void Register_UnhandledException_Subscribes()
     {