fix: Make fetching scene name run on IL2CPP only (#2206)

Author: bitsandfoxes

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - The SDK no longer attaches screenshots when capturing errors in the Unity Editor. ([#2163](https://github.com/getsentry/sentry-unity/pull/2163))
 
+### Fixes
+
+- The SDK no longer causes crashes with `EXCEPTION_ACCESS_VIOLATION_READ` when using the Mono scripting backend. The SDK now adds the active scene name to the context in IL2CPP builds only ([#2206](https://github.com/getsentry/sentry-unity/pull/2206))
+
 ### Dependencies
 
 - Bump .NET SDK from v5.7.0-beta.0 to v5.11.1 ([#2154](https://github.com/getsentry/sentry-unity/pull/2154), [#2188](https://github.com/getsentry/sentry-unity/pull/2188), [#2207](https://github.com/getsentry/sentry-unity/pull/2207))

src/Sentry.Unity/Integrations/UnityScopeIntegration.cs

@@ -17,15 +17,17 @@ internal static class UnitySdkInfo
 internal class UnityScopeIntegration : ISdkIntegration
 {
     private readonly IApplication _application;
+    private readonly ISentryUnityInfo? _unityInfo;
 
-    public UnityScopeIntegration(IApplication application)
+    public UnityScopeIntegration(IApplication application, ISentryUnityInfo? unityInfo)
     {
         _application = application;
+        _unityInfo = unityInfo;
     }
 
     public void Register(IHub hub, SentryOptions options)
     {
-        var scopeUpdater = new UnityScopeUpdater((SentryUnityOptions)options, _application);
+        var scopeUpdater = new UnityScopeUpdater((SentryUnityOptions)options, _application, _unityInfo);
         hub.ConfigureScope(scopeUpdater.ConfigureScope);
     }
 }
@@ -34,12 +36,14 @@ internal class UnityScopeUpdater
 {
     private readonly SentryUnityOptions _options;
     private readonly IApplication _application;
+    private readonly ISentryUnityInfo? _unityInfo;
     private readonly ISceneManager _sceneManager;
 
-    public UnityScopeUpdater(SentryUnityOptions options, IApplication application, ISceneManager? sceneManager = null)
+    public UnityScopeUpdater(SentryUnityOptions options, IApplication application, ISentryUnityInfo? unityInfo = null, ISceneManager? sceneManager = null)
     {
         _options = options;
         _application = application;
+        _unityInfo = unityInfo;
         _sceneManager = sceneManager ?? SceneManagerAdapter.Instance;
     }
 
@@ -142,7 +146,12 @@ private void PopulateUnity(Protocol.Unity unity)
         unity.TargetFrameRate = MainThreadData.TargetFrameRate;
         unity.CopyTextureSupport = MainThreadData.CopyTextureSupport;
         unity.RenderingThreadingMode = MainThreadData.RenderingThreadingMode;
-        unity.ActiveSceneName = _sceneManager.GetActiveScene().Name;
+
+        if (_unityInfo?.IL2CPP is true)
+        {
+            // Currently an IL2CPP only feature: see https://github.com/getsentry/sentry-unity/issues/2181
+            unity.ActiveSceneName = _sceneManager.GetActiveScene().Name;
+        }
     }
 
     private void PopulateTags(Action<string, string> setTag)

src/Sentry.Unity/ScriptableSentryUnityOptions.cs

@@ -135,7 +135,7 @@ internal SentryUnityOptions ToSentryUnityOptions(bool isBuilding, ISentryUnityIn
     {
         application ??= ApplicationAdapter.Instance;
 
-        var options = new SentryUnityOptions(isBuilding, application)
+        var options = new SentryUnityOptions(isBuilding, application, unityInfo)
         {
             Enabled = Enabled,
             Dsn = Dsn,

src/Sentry.Unity/SentryUnityOptions.cs

@@ -296,11 +296,12 @@ internal string? DefaultUserId
 
     public SentryUnityOptions() : this(false, ApplicationAdapter.Instance) { }
 
-    internal SentryUnityOptions(bool isBuilding, IApplication application) :
-        this(SentryMonoBehaviour.Instance, application, isBuilding)
+    internal SentryUnityOptions(bool isBuilding, IApplication application, ISentryUnityInfo? unityInfo = null) :
+        this(SentryMonoBehaviour.Instance, application, isBuilding, unityInfo)
     { }
 
-    internal SentryUnityOptions(SentryMonoBehaviour behaviour, IApplication application, bool isBuilding)
+    // For testing
+    internal SentryUnityOptions(SentryMonoBehaviour behaviour, IApplication application, bool isBuilding, ISentryUnityInfo? unityInfo = null)
     {
         // IL2CPP doesn't support Process.GetCurrentProcess().StartupTime
         DetectStartupTime = StartupTimeDetectionMode.Fast;
@@ -315,7 +316,7 @@ internal SentryUnityOptions(SentryMonoBehaviour behaviour, IApplication applicat
         this.AddIntegration(new UnityLogHandlerIntegration(this));
         this.AddIntegration(new UnityApplicationLoggingIntegration());
         this.AddIntegration(new AnrIntegration(behaviour));
-        this.AddIntegration(new UnityScopeIntegration(application));
+        this.AddIntegration(new UnityScopeIntegration(application, unityInfo));
         this.AddIntegration(new UnityBeforeSceneLoadIntegration());
         this.AddIntegration(new SceneManagerIntegration());
         this.AddIntegration(new SessionIntegration(behaviour));

test/Sentry.Unity.Tests/UnityEventScopeTests.cs

@@ -109,7 +109,7 @@ public void SentrySdkCaptureEvent(bool captureOnUiThread)
             RenderingThreadingMode = new Lazy<string>(() => "MultiThreaded"),
             StartTime = new(() => DateTimeOffset.UtcNow),
         };
-        var options = new SentryUnityOptions(_sentryMonoBehaviour, _testApplication, false)
+        var options = new SentryUnityOptions(_sentryMonoBehaviour, _testApplication, false, new TestUnityInfo { IL2CPP = true })
         {
             Dsn = "https://[email protected]/5606182",
             Enabled = true,
@@ -430,7 +430,9 @@ public void DeviceProtocol_Assigned()
     }
 
     [Test]
-    public void UnityProtocol_Assigned()
+    [TestCase(true)]
+    [TestCase(false)]
+    public void UnityProtocol_Assigned(bool isIL2CPP)
     {
         var sceneManager = new SceneManagerIntegrationTests.FakeSceneManager { ActiveSceneName = "TestScene" };
         var systemInfo = new TestSentrySystemInfo
@@ -444,7 +446,7 @@ public void UnityProtocol_Assigned()
         MainThreadData.SentrySystemInfo = systemInfo;
         MainThreadData.CollectData();
 
-        var sut = new UnityScopeUpdater(_sentryOptions, _testApplication, sceneManager);
+        var sut = new UnityScopeUpdater(_sentryOptions, _testApplication, new TestUnityInfo { IL2CPP = isIL2CPP }, sceneManager);
         var scope = new Scope(_sentryOptions);
 
         // act
@@ -459,7 +461,7 @@ public void UnityProtocol_Assigned()
         Assert.AreEqual(systemInfo.TargetFrameRate!.Value, unityProtocol.TargetFrameRate);
         Assert.AreEqual(systemInfo.CopyTextureSupport!.Value, unityProtocol.CopyTextureSupport);
         Assert.AreEqual(systemInfo.RenderingThreadingMode!.Value, unityProtocol.RenderingThreadingMode);
-        Assert.AreEqual(sceneManager.GetActiveScene().Name, unityProtocol.ActiveSceneName);
+        Assert.AreEqual(isIL2CPP ? sceneManager.GetActiveScene().Name : null, unityProtocol.ActiveSceneName);
     }
 
     [Test]