Add CaptureLastError for ASP.NET (#1411)

Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io>

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+## Features
+
+- Add CaptureLastError as an extension method to the Server class on ASP.NET ([#1411](https://github.com/getsentry/sentry-dotnet/pull/1411))
 - Add IsDynamicCode* to events ([#1418](https://github.com/getsentry/sentry-dotnet/pull/1418))
 
 ## 3.12.3

src/Sentry.AspNet/SentryHttpServerUtilityExtensions.cs

@@ -0,0 +1,30 @@
+using System.Web;
+using Sentry.Extensibility;
+using Sentry.Protocol;
+
+namespace Sentry.AspNet;
+
+/// <summary>
+/// HttpServerUtility extensions.
+/// </summary>
+public static class SentryHttpServerUtilityExtensions
+{
+    /// <summary>
+    /// Captures the last error from the given HttpServerUtility and sends it to Sentry.
+    /// </summary>
+    /// <param name="server">The HttpServerUtility that contains the last error.</param>
+    /// <returns>A SentryId.</returns>
+    public static SentryId CaptureLastError(this HttpServerUtility server) => server.CaptureLastError(HubAdapter.Instance);
+
+    // for testing
+    internal static SentryId CaptureLastError(this HttpServerUtility server, IHub hub)
+    {
+        if (server.GetLastError() is { } exception)
+        {
+            exception.Data[Mechanism.HandledKey] = false;
+            exception.Data[Mechanism.MechanismKey] = "HttpApplication.Application_Error";
+            return hub.CaptureException(exception);
+        }
+        return SentryId.Empty;
+    }
+}

test/Sentry.AspNet.Tests/ApiApprovalTests.Run.DotNet4_6.verified.txt

@@ -10,4 +10,8 @@ namespace Sentry.AspNet
     {
         public static void AddAspNet(this Sentry.SentryOptions options, Sentry.Extensibility.RequestSize maxRequestBodySize = 0) { }
     }
+    public static class SentryHttpServerUtilityExtensions
+    {
+        public static Sentry.SentryId CaptureLastError(this System.Web.HttpServerUtility server) { }
+    }
 }

test/Sentry.AspNet.Tests/SentryHttpServerUtilityExtensionsTests.cs

@@ -0,0 +1,57 @@
+using System.Web;
+
+namespace Sentry.AspNet.Tests;
+
+public class SentryHttpServerUtilityExtensionsTests
+{
+    private class Fixture
+    {
+        public SentryId Id { get; set; }
+
+        public IHub GetSut()
+        {
+            Id = SentryId.Create();
+            var hub = Substitute.For<IHub>();
+            hub.IsEnabled.Returns(true);
+            hub.CaptureEvent(Arg.Any<SentryEvent>()).Returns(Id);
+            return hub;
+        }
+    }
+
+    private readonly Fixture _fixture = new();
+
+    [Fact]
+    public void CaptureLastError_WithError_UnhandledErrorCaptured()
+    {
+        // Arrange
+        var hub = _fixture.GetSut();
+        var exception = new Exception();
+
+        var context = new HttpContext(new HttpRequest("", "http://test", null), new HttpResponse(new StringWriter()));
+        context.AddError(exception);
+
+        // Act
+        var receivedId = context.Server.CaptureLastError(hub);
+
+        // Assert
+        hub.Received(1).CaptureEvent(Arg.Is<SentryEvent>(@event => @event.Exception == exception));
+        Assert.False(exception.Data[Mechanism.HandledKey] as bool?);
+        Assert.Equal("HttpApplication.Application_Error", exception.Data[Mechanism.MechanismKey]);
+        Assert.Equal(_fixture.Id, receivedId);
+    }
+
+    [Fact]
+    public void CaptureLastError_WithoutError_DoNothing()
+    {
+        // Arrange
+        var hub = _fixture.GetSut();
+        var context = new HttpContext(new HttpRequest("", "http://test", null), new HttpResponse(new StringWriter()));
+
+        // Act
+        var receivedId = context.Server.CaptureLastError(hub);
+
+        // Assert
+        hub.Received(0).CaptureEvent(Arg.Any<SentryEvent>());
+        Assert.Equal(SentryId.Empty, receivedId);
+    }
+}