Expose EnumerateChainedExceptions (#1733)

Author: SimonCropp

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Expose EnumerateChainedExceptions ([#1733](https://github.com/getsentry/sentry-dotnet/pull/1733))
 - Android Scope Sync ([#1737](https://github.com/getsentry/sentry-dotnet/pull/1737))
 - Enable logging in MAUI ([#1738](https://github.com/getsentry/sentry-dotnet/pull/1738))
 

src/Sentry/Internal/MainExceptionProcessor.cs

@@ -82,49 +82,34 @@ keyValue.Value is string tagValue &&
 
         internal IEnumerable<SentryException> CreateSentryException(Exception exception)
         {
-            if (exception is AggregateException ae)
-            {
-                foreach (var inner in ae.InnerExceptions.SelectMany(CreateSentryException))
-                {
-                    yield return inner;
-                }
-
-                if (!_options.KeepAggregateException)
-                {
-                    yield break;
-                }
-            }
-            else if (exception.InnerException != null)
-            {
-                foreach (var inner in CreateSentryException(exception.InnerException))
-                {
-                    yield return inner;
-                }
-            }
+            return exception.EnumerateChainedExceptions(_options)
+                .Select(BuildSentryException);
+        }
 
+        private SentryException BuildSentryException(Exception innerException)
+        {
             var sentryEx = new SentryException
             {
-                Type = exception.GetType()?.FullName,
-                Module = exception.GetType()?.Assembly?.FullName,
-                Value = exception.Message,
+                Type = innerException.GetType()?.FullName,
+                Module = innerException.GetType()?.Assembly?.FullName,
+                Value = innerException.Message,
                 ThreadId = Environment.CurrentManagedThreadId,
-                Mechanism = GetMechanism(exception)
+                Mechanism = GetMechanism(innerException)
             };
 
-            if (exception.Data.Count != 0)
+            if (innerException.Data.Count != 0)
             {
-                foreach (var key in exception.Data.Keys)
+                foreach (var key in innerException.Data.Keys)
                 {
                     if (key is string keyString)
                     {
-                        sentryEx.Data[keyString] = exception.Data[key];
+                        sentryEx.Data[keyString] = innerException.Data[key];
                     }
                 }
             }
 
-            sentryEx.Stacktrace = SentryStackTraceFactoryAccessor().Create(exception);
-
-            yield return sentryEx;
+            sentryEx.Stacktrace = SentryStackTraceFactoryAccessor().Create(innerException);
+            return sentryEx;
         }
 
         internal static Mechanism GetMechanism(Exception exception)

src/Sentry/SentryExceptionExtensions.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Linq;
+using Sentry;
 using Sentry.Internal;
 
 /// <summary>
@@ -18,6 +20,42 @@ public static class SentryExceptionExtensions
     public static void AddSentryTag(this Exception ex, string name, string value)
         => ex.Data.Add($"{MainExceptionProcessor.ExceptionDataTagKey}{name}", value);
 
+    /// <summary>
+    /// Recursively enumerates all <see cref="AggregateException.InnerExceptions"/> and <see cref="Exception.InnerException"/>
+    /// Not for public use.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public static IEnumerable<Exception> EnumerateChainedExceptions(this Exception exception, SentryOptions options)
+    {
+        if (exception is AggregateException aggregateException)
+        {
+            foreach (var inner in EnumerateInner(options, aggregateException))
+            {
+                yield return inner;
+            }
+
+            if (!options.KeepAggregateException)
+            {
+                yield break;
+            }
+        }
+        else if (exception.InnerException != null)
+        {
+            foreach (var inner in exception.InnerException.EnumerateChainedExceptions(options))
+            {
+                yield return inner;
+            }
+        }
+
+        yield return exception;
+    }
+
+    private static IEnumerable<Exception> EnumerateInner(SentryOptions options, AggregateException aggregateException)
+    {
+        return aggregateException.InnerExceptions
+            .SelectMany(exception => exception.EnumerateChainedExceptions(options));
+    }
+
     /// <summary>
     /// Set a Sentry's structured Context to the Exception.
     /// </summary>

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

@@ -1403,4 +1403,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1403,4 +1403,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1403,4 +1403,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1402,4 +1402,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1402,4 +1402,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1403,4 +1403,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }

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

@@ -1403,4 +1403,5 @@ public static class SentryExceptionExtensions
 {
     public static void AddSentryContext(this System.Exception ex, string name, System.Collections.Generic.IReadOnlyDictionary<string, object> data) { }
     public static void AddSentryTag(this System.Exception ex, string name, string value) { }
+    public static System.Collections.Generic.IEnumerable<System.Exception> EnumerateChainedExceptions(this System.Exception exception, Sentry.SentryOptions options) { }
 }