fix: Disable screenshot capture in Editor (#2163)

Author: bitsandfoxes

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Significant change in behavior
+
+- The SDK no longer attaches screenshots when capturing errors in the Unity Editor. ([#2163](https://github.com/getsentry/sentry-unity/pull/2163))
+
 ### Dependencies
 
 - Bump Java SDK from v8.11.1 to v8.12.0 ([#2155](https://github.com/getsentry/sentry-unity/pull/2155))

src/Sentry.Unity/ScreenshotEventProcessor.cs

@@ -1,15 +1,19 @@
 using Sentry.Extensibility;
+using Sentry.Unity.Integrations;
 using UnityEngine;
 
 namespace Sentry.Unity;
 
 public class ScreenshotEventProcessor : ISentryEventProcessorWithHint
 {
     private readonly SentryUnityOptions _options;
+    private readonly IApplication _application;
+    public ScreenshotEventProcessor(SentryUnityOptions sentryOptions) : this(sentryOptions, null) { }
 
-    public ScreenshotEventProcessor(SentryUnityOptions sentryOptions)
+    internal ScreenshotEventProcessor(SentryUnityOptions sentryOptions, IApplication? application)
     {
         _options = sentryOptions;
+        _application = application ?? ApplicationAdapter.Instance;
     }
 
     public SentryEvent? Process(SentryEvent @event)
@@ -21,11 +25,18 @@ public ScreenshotEventProcessor(SentryUnityOptions sentryOptions)
     {
         if (!MainThreadData.IsMainThread())
         {
+            _options.DiagnosticLogger?.LogDebug("Screenshot capture skipped. Can't capture screenshots on other than the main thread.");
             return @event;
         }
 
         if (_options.BeforeCaptureScreenshotInternal?.Invoke() is not false)
         {
+            if (_application.IsEditor)
+            {
+                _options.DiagnosticLogger?.LogInfo("Screenshot capture skipped. Capturing screenshots it not supported in the Editor");
+                return @event;
+            }
+
             if (Screen.width == 0 || Screen.height == 0)
             {
                 _options.DiagnosticLogger?.LogWarning("Can't capture screenshots on a screen with a resolution of '{0}x{1}'.", Screen.width, Screen.height);
@@ -37,7 +48,7 @@ public ScreenshotEventProcessor(SentryUnityOptions sentryOptions)
         }
         else
         {
-            _options.DiagnosticLogger?.LogInfo("Screenshot attachment skipped by BeforeAttachScreenshot callback.");
+            _options.DiagnosticLogger?.LogInfo("Screenshot capture skipped by BeforeAttachScreenshot callback.");
         }
 
 

src/Sentry.Unity/ViewHierarchyEventProcessor.cs

@@ -26,7 +26,7 @@ public ViewHierarchyEventProcessor(SentryUnityOptions sentryOptions)
     {
         if (!MainThreadData.IsMainThread())
         {
-            _options.DiagnosticLogger?.LogDebug("Can't capture view hierarchy on other than main (UI) thread.");
+            _options.DiagnosticLogger?.LogDebug("Hierarchy capture skipped. Can't capture hierarchy on other than the main thread.");
             return @event;
         }
 
@@ -36,7 +36,7 @@ public ViewHierarchyEventProcessor(SentryUnityOptions sentryOptions)
         }
         else
         {
-            _options.DiagnosticLogger?.LogInfo("View hierarchy attachment skipped by BeforeAttachViewHierarchy callback.");
+            _options.DiagnosticLogger?.LogInfo("Hierarchy capture skipped by BeforeAttachViewHierarchy callback.");
         }
 
         return @event;

test/Sentry.Unity.Tests/ScreenshotEventProcessorTests.cs

@@ -1,7 +1,10 @@
+using System;
 using System.IO;
 using System.Threading;
 using NUnit.Framework;
+using Sentry.Unity.Integrations;
 using UnityEngine;
+using Sentry.Unity.Tests.Stubs;
 
 namespace Sentry.Unity.Tests;
 
@@ -10,8 +13,9 @@ public class ScreenshotEventProcessorTests
     private class Fixture
     {
         public SentryUnityOptions Options = new() { AttachScreenshot = true };
+        public TestApplication TestApplication = new();
 
-        public ScreenshotEventProcessor GetSut() => new(Options);
+        public ScreenshotEventProcessor GetSut() => new(Options, TestApplication);
     }
 
     private Fixture _fixture = null!;
@@ -42,6 +46,7 @@ public void GetTargetResolution_ReturnsTargetMaxSize(ScreenshotQuality quality,
     [Test]
     public void Process_IsMainThread_AddsScreenshotToHint()
     {
+        _fixture.TestApplication.IsEditor = false;
         var sut = _fixture.GetSut();
         var sentryEvent = new SentryEvent();
         var hint = new SentryHint();
@@ -72,6 +77,7 @@ public void Process_IsNonMainThread_DoesNotAddScreenshotToHint()
     [TestCase(false)]
     public void Process_BeforeCaptureScreenshotCallbackProvided_RespectsScreenshotCaptureDecision(bool captureScreenshot)
     {
+        _fixture.TestApplication.IsEditor = false;
         _fixture.Options.SetBeforeCaptureScreenshot(() => captureScreenshot);
         var sut = _fixture.GetSut();
         var sentryEvent = new SentryEvent();
@@ -111,4 +117,22 @@ public void CaptureScreenshot_QualitySetToFull_ScreenshotInFullSize()
 
         Assert.IsTrue(texture.width == testScreenSize && texture.height == testScreenSize);
     }
+
+    [Test]
+    [TestCase(true, 0)]
+    [TestCase(false, 1)]
+    public void Process_InEditorEnvironment_DoesNotCaptureScreenshot(bool isEditor, int expectedAttachmentCount)
+    {
+        // Arrange
+        _fixture.TestApplication.IsEditor = isEditor;
+        var sut = _fixture.GetSut();
+        var sentryEvent = new SentryEvent();
+        var hint = new SentryHint();
+
+        // Act
+        sut.Process(sentryEvent, hint);
+
+        // Assert
+        Assert.AreEqual(expectedAttachmentCount, hint.Attachments.Count);
+    }
 }

test/SharedClasses/TestApplication.cs

@@ -27,7 +27,7 @@ public TestApplication(
     public event Application.LogCallback? LogMessageReceived;
     public event Action? Quitting;
     public string ActiveSceneName => "TestSceneName";
-    public bool IsEditor { get; }
+    public bool IsEditor { get; set; }
     public string ProductName { get; }
     public string Version { get; }
     public string BuildGUID { get; }