Updated tests and changelog

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - User Feedback can now be captured without errors/exceptions. Note that these APIs replace the older UserFeedback APIs, which have now been marked as obsolete (and will be removed in a future major version bump) ([#3981](https://github.com/getsentry/sentry-dotnet/pull/3981))
+- Exception.HResult is now included in the mechanism data for all exceptions ([#4029](https://github.com/getsentry/sentry-dotnet/pull/4029))
 
 ### Fixes
 

test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt

@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],

test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt

@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],

test/Sentry.NLog.Tests/IntegrationTests.Simple.Mono4_0.verified.txt

@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],

test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt

@@ -224,7 +224,8 @@
                   Synthetic: false,
                   IsExceptionGroup: false,
                   Data: {
-                    details: Do work always throws.
+                    details: Do work always throws.,
+                    HResult: 0x80131500
                   }
                 }
               }

test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt

@@ -224,7 +224,8 @@
                   Synthetic: false,
                   IsExceptionGroup: false,
                   Data: {
-                    details: Do work always throws.
+                    details: Do work always throws.,
+                    HResult: 0x80131500
                   }
                 }
               }

test/Sentry.Tests/Internals/MainExceptionProcessorTests.CreateSentryException_Aggregate.verified.txt

@@ -8,7 +8,10 @@
       Synthetic: false,
       IsExceptionGroup: false,
       ExceptionId: 2,
-      ParentId: 0
+      ParentId: 0,
+      Data: {
+        HResult: 0x80131500
+      }
     }
   },
   {
@@ -20,7 +23,10 @@
       Synthetic: false,
       IsExceptionGroup: false,
       ExceptionId: 1,
-      ParentId: 0
+      ParentId: 0,
+      Data: {
+        HResult: 0x80131500
+      }
     }
   },
   {
@@ -33,7 +39,8 @@
       IsExceptionGroup: true,
       ExceptionId: 0,
       Data: {
-        foo: bar
+        foo: bar,
+        HResult: 0x80131500
       }
     }
   }

test/Sentry.Tests/Internals/MainExceptionProcessorTests.cs

@@ -12,7 +12,7 @@ private class Fixture
     private readonly Fixture _fixture = new();
 
     [Fact]
-    public void Process_ExceptionsWithoutData_MechanismDataIsEmpty()
+    public void Process_ExceptionsWithoutData_MechanismDataIsMinimal()
     {
         var sut = _fixture.GetSut();
         var evt = new SentryEvent();
@@ -21,7 +21,12 @@ public void Process_ExceptionsWithoutData_MechanismDataIsEmpty()
         sut.Process(ex, evt);
 
         var sentryException = evt.SentryExceptions!.Single();
-        Assert.Empty(sentryException.Mechanism!.Data);
+
+        // All managed exceptions has an HResult, at a bare minimum (which we store in the Mechanism.Data)
+        sentryException.Mechanism!.Data.Should().BeEquivalentTo(new Dictionary<string, string>()
+        {
+            ["HResult"] = "0x80131500" // The default value of HRESULT for managed exceptions (COR_E_EXCEPTION)
+        });
     }
 
     [Fact]
@@ -109,7 +114,13 @@ public void CreateSentryException_DataHasObjectAsKey_ItemIgnored()
 
         var actual = sut.CreateSentryExceptions(ex).Single();
 
-        Assert.Null(actual.Mechanism);
+        // The custom data won't be added, but the mechanism data will still contain an HResult.
+        // We add the HResult for all exceptions
+        actual.Mechanism!.Data.Should().BeEquivalentTo(new Dictionary<string, string>()
+        {
+            ["HResult"] = "0x80131500" // The default value of HRESULT for managed exceptions (COR_E_EXCEPTION)
+        });
+
     }
 
     [Fact]