Flatten aggregate exception

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Flatten AggregateException ([#1672](https://github.com/getsentry/sentry-dotnet/pull/1672))
+
 ### Features
 
 - Move tunnel functionality into Sentry.AspNetCore ([#1645](https://github.com/getsentry/sentry-dotnet/pull/1645))

src/Sentry/Internal/MainExceptionProcessor.cs

@@ -88,6 +88,11 @@ internal IEnumerable<SentryException> CreateSentryException(Exception exception)
                 {
                     yield return inner;
                 }
+
+                if (!_options.KeepAggregateException)
+                {
+                    yield break;
+                }
             }
             else if (exception.InnerException != null)
             {

src/Sentry/SentryOptions.cs

@@ -591,6 +591,13 @@ public StackTraceMode StackTraceMode
         /// </summary>
         public Func<bool>? CrashedLastRun { get; set; }
 
+        /// <summary>
+        /// Keep <see cref="AggregateException"/> in sentry logging.
+        /// The default behaviour is to only log <see cref="AggregateException.InnerExceptions"/> and not include the root <see cref="AggregateException"/>.
+        /// Set KeepAggregateException to true to include the root <see cref="AggregateException"/>.
+        /// </summary>
+        public bool KeepAggregateException { get; set; }
+
         /// <summary>
         /// Creates a new instance of <see cref="SentryOptions"/>
         /// </summary>

test/Directory.Build.props

@@ -41,7 +41,7 @@
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" />
     <PackageReference Include="Xunit.SkippableFact" Version="1.4.13" />
-    <PackageReference Include="Verify.Xunit" Version="16.7.0" />
+    <PackageReference Include="Verify.Xunit" Version="16.8.2" />
     <PackageReference Include="Verify.DiffPlex" Version="1.2.0" />
     <PackageReference Include="PublicApiGenerator" Version="10.3.0" />
     <PackageReference Include="GitHubActionsTestLogger" Version="1.4.1" />

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -484,6 +484,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -485,6 +485,7 @@ namespace Sentry
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
+        public bool KeepAggregateException { get; set; }
         public long MaxAttachmentSize { get; set; }
         public int MaxBreadcrumbs { get; set; }
         public int MaxCacheItems { get; set; }

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

@@ -0,0 +1,14 @@
+[
+  {
+    Type: System.Exception,
+    Value: Inner message1,
+    ThreadId: Id_1,
+    Mechanism: {}
+  },
+  {
+    Type: System.Exception,
+    Value: Inner message2,
+    ThreadId: Id_1,
+    Mechanism: {}
+  }
+]

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

@@ -0,0 +1,19 @@
+[
+  {
+    Type: System.Exception,
+    Value: Inner message1,
+    ThreadId: Id_1,
+    Mechanism: {}
+  },
+  {
+    Type: System.Exception,
+    Value: Inner message2,
+    ThreadId: Id_1,
+    Mechanism: {}
+  },
+  {
+    Type: System.AggregateException,
+    ThreadId: Id_1,
+    Mechanism: {}
+  }
+]

test/Sentry.Tests/Internals/MainExceptionProcessorTests.cs

@@ -1,5 +1,6 @@
 namespace Sentry.Tests.Internals;
 
+[UsesVerify]
 public class MainExceptionProcessorTests
 {
     private class Fixture
@@ -149,7 +150,38 @@ public void CreateSentryException_DataHasObjectAsKey_ItemIgnored()
     }
 
     [Fact]
-    public void Process_HasTagsOnExceptionData_TagsSetted()
+    public Task CreateSentryException_Aggregate()
+    {
+        var sut = _fixture.GetSut();
+        var aggregateException = BuildAggregateException();
+
+        var sentryException = sut.CreateSentryException(aggregateException);
+
+        return Verify(sentryException);
+    }
+
+    [Fact]
+    public Task CreateSentryException_Aggregate_Keep()
+    {
+        _fixture.SentryOptions.KeepAggregateException = true;
+        var sut = _fixture.GetSut();
+        var aggregateException = BuildAggregateException();
+
+        var sentryException = sut.CreateSentryException(aggregateException);
+
+        return Verify(sentryException)
+            .ScrubLines(x => x.Contains("One or more errors occurred"));
+    }
+
+    private static AggregateException BuildAggregateException()
+    {
+        return new AggregateException(
+            new Exception("Inner message1"),
+            new Exception("Inner message2"));
+    }
+
+    [Fact]
+    public void Process_HasTagsOnExceptionData_TagsSet()
     {
         //Assert
         var sut = _fixture.GetSut();

test/Sentry.Tests/ModuleInit.cs

@@ -6,6 +6,7 @@ public static class ModuleInit
     public static void Init()
     {
         VerifyDiffPlex.Initialize();
+        VerifierSettings.IgnoreMember<SentryException>(_=>_.Module);
         VerifierSettings.MemberConverter<Breadcrumb, IReadOnlyDictionary<string, string>>(
             target => target.Data,
             (_, value) =>