feat: Marking Unity exceptions as unhandled by default

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Unity logged exceptions are marked as unhandled by default ([#542](https://github.com/getsentry/sentry-unity/pull/542))
+
 ### Fixes
 
 - Importing the link.xml when opening the config window no longer causes an infinite loop ([#539](https://github.com/getsentry/sentry-unity/pull/539))

samples/unity-of-bugs/Assets/Scripts/BugFarmButtons.cs

@@ -32,7 +32,7 @@ public void ThrowExceptionAndCatch()
         }
         catch (Exception e)
         {
-            Debug.LogException(e);
+            SentrySdk.CaptureException(e);
         }
     }
 
@@ -46,7 +46,7 @@ public void ThrowNullAndCatch()
         }
         catch (Exception e)
         {
-            Debug.LogException(e);
+            SentrySdk.CaptureException(e);
         }
     }
 

src/Sentry.Unity/UnityLogException.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using Sentry.Internal;
 using Sentry.Protocol;
 using UnityEngine;
 
@@ -21,10 +22,9 @@ public UnityLogException(string logString, string logStackTrace)
         {
             LogString = logString;
             LogStackTrace = logStackTrace;
-            Data[Mechanism.MechanismKey] = "unity.log";
         }
 
-        private UnityLogException() : base()
+        internal UnityLogException() : base()
         {
             LogString = "";
             LogStackTrace = "";
@@ -140,7 +140,12 @@ public SentryException ToSentryException()
             {
                 Stacktrace = stacktrace,
                 Type = excType,
-                Value = excValue
+                Value = excValue,
+                Mechanism = new Mechanism
+                {
+                    Handled = false,
+                    Type = "unity.log"
+                }
             };
         }
 

test/Sentry.Unity.Tests/IntegrationTests.cs

@@ -217,6 +217,28 @@ public IEnumerator BugFarmScene_MultipleSentryInit_SendEventForTheLatest()
             Assert.AreEqual(1, nextEventCapture.Events.Count);
         }
 
+        [UnityTest]
+        public IEnumerator BugFarmScene_DebugLogException_IsMarkedUnhandled()
+        {
+            yield return SetupSceneCoroutine("1_BugFarm");
+
+            // arrange
+            var testEventCapture = new TestEventCapture();
+            using var _ = InitSentrySdk(o =>
+            {
+                o.AddIntegration(new UnityApplicationLoggingIntegration(eventCapture: testEventCapture));
+            });
+            var testBehaviour = new GameObject("TestHolder").AddComponent<TestMonoBehaviour>();
+
+            // act
+            testBehaviour.gameObject.SendMessage(nameof(testBehaviour.DebugLogException));
+
+            // assert
+            Assert.NotNull(testEventCapture.Events.SingleOrDefault(sentryEvent =>
+                sentryEvent.SentryExceptions.SingleOrDefault(exception =>
+                    exception.Mechanism?.Handled is false) is not null));
+        }
+
         [UnityTest]
         public IEnumerator Init_OptionsAreDefaulted()
         {

test/Sentry.Unity.Tests/TestBehaviours/TestMonoBehaviour.cs

@@ -13,5 +13,8 @@ public void TestException()
 
         public void DebugLogError()
             => Debug.LogError("error");
+
+        public void DebugLogException()
+            => Debug.LogException(new Exception("Unity log exception"));
     }
 }

test/Sentry.Unity.Tests/UnityLogExceptionTests.cs

@@ -7,6 +7,14 @@ namespace Sentry.Unity.Tests
 {
     public class UnityLogExceptionTests
     {
+        [Test]
+        public void ToSentryException_MarkedAsUnhandled()
+        {
+            var sentryException = new UnityLogException().ToSentryException();
+
+            Assert.IsFalse(sentryException.Mechanism?.Handled);
+        }
+
         [TestCaseSource(nameof(ParsingTestCases))]
         public void ToSentryException_ParsingTestCases(
             string logString,
@@ -103,6 +111,11 @@ public void ToSentryException_ParsingTestCases(
                                 InApp = true
                             },
                         }
+                    },
+                    Mechanism = new Mechanism
+                    {
+                        Handled = false,
+                        Type = "unity.log"
                     }
                 } },
             new object[] {
@@ -236,6 +249,11 @@ public void ToSentryException_ParsingTestCases(
                                 InApp = false
                             },
                         }
+                    },
+                    Mechanism = new Mechanism
+                    {
+                        Handled = false,
+                        Type = "unity.log"
                     }
                 } },
             // TODO: Current parsing logic isn't able to parse this (editor only stack trace)