fix: hide StackTraceMode from options to avoid accidental errors when used with IL2CPP (#1033)

Author: vaind

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Additional IL2CPP arguments get added only once ([#997](https://github.com/getsentry/sentry-unity/pull/997))
 - Releasing temp render texture after capturing a screenshot ([#983](https://github.com/getsentry/sentry-unity/pull/983))
 - Automatic screenshot mirroring on select devices. ([#1019](https://github.com/getsentry/sentry-unity/pull/1019))
+- Hide `StackTraceMode` from options to avoid accidental errors when used with IL2CPP ([#1033](https://github.com/getsentry/sentry-unity/pull/1033))
 
 ### Features
 

Directory.Build.targets

@@ -396,7 +396,7 @@ Log.LogMessage("Unity Version: " + version);
     </Task>
   </UsingTask>
 
-    <!-- Locate the TestRunner.dlls by filling the wildcard with the template version number. 3d is the default template -->
+  <!-- Locate the TestRunner.dlls by filling the wildcard with the template version number. 3d is the default template -->
   <UsingTask TaskName="LocateTestRunner" TaskFactory="RoslynCodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
     <ParameterGroup>
       <UnityLibcache ParameterType="System.String" Required="true" />

src/Sentry.Unity/SentryUnityOptions.cs

@@ -116,6 +116,9 @@ public sealed class SentryUnityOptions : SentryOptions
         /// </remarks>
         public bool Il2CppLineNumberSupportEnabled { get; set; } = true;
 
+        /// This option is hidden due to incompatibility between IL2CPP and Enhanced mode.
+        private new StackTraceMode StackTraceMode { get; set; }
+
         // Initialized by native SDK binding code to set the User.ID in .NET (UnityEventProcessor).
         internal string? _defaultUserId;
         internal string? DefaultUserId
@@ -175,8 +178,9 @@ internal SentryUnityOptions(SentryMonoBehaviour behaviour, IApplication applicat
             RequestBodyCompressionLevel = CompressionLevelWithAuto.NoCompression;
             InitCacheFlushTimeout = System.TimeSpan.Zero;
 
-            // Ben.Demystifer not compatible with IL2CPP
-            StackTraceMode = StackTraceMode.Original;
+            // Ben.Demystifer not compatible with IL2CPP. We could allow Enhanced in the future for Mono.
+            // See https://github.com/getsentry/sentry-unity/issues/675
+            base.StackTraceMode = StackTraceMode.Original;
             IsEnvironmentUser = false;
 
             if (application.ProductName is string productName

test/Sentry.Unity.Tests/SentryUnityTests.cs

@@ -23,7 +23,6 @@ public void AsyncStackTrace()
         {
             var options = new SentryUnityOptions();
             options.AttachStacktrace = true;
-            options.StackTraceMode = StackTraceMode.Original;
             var sut = new SentryStackTraceFactory(options);
 
             IList<SentryStackFrame> framesSentry = null!;