feat: Set platform specific defaults for EnvironmentUser (#2402)

* Platform specific defaults for 'EnvironmentUser'

* Updated CHANGELOG.md

Author: bitsandfoxes

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - The SDK now also reports the currently allocated memory when reporting an event or transaction. ([#2398](https://github.com/getsentry/sentry-unity/pull/2398))
+- The SDK defaults `EnvironmentUser` to sensible values based on the current platform. This is still guarded by the `SendDefaultPII` flag. ([#2402](https://github.com/getsentry/sentry-unity/pull/2402))
 
 ### Fixes 
 

src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs

@@ -18,8 +18,8 @@ internal static void Display(ScriptableSentryUnityOptions options)
 
             options.IsEnvironmentUser = EditorGUILayout.Toggle(
                 new GUIContent("Auto Set UserName", "Whether to report the 'Environment.UserName' as " +
-                                                    "the User affected in the event. Should be disabled for " +
-                                                    "Android and iOS."),
+                                                    "the User affected in the event. Defaults to enabled on desktop " +
+                                                    "platforms and disabled on mobile and console platforms."),
                 options.IsEnvironmentUser);
 
             EditorGUI.indentLevel--;

src/Sentry.Unity/SentryUnityOptions.cs

@@ -374,7 +374,24 @@ internal SentryUnityOptions(IApplication? application = null,
         // 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;
+
+        IsEnvironmentUser = application.Platform switch
+        {
+            // Desktop: true (capture logged-in user)
+            RuntimePlatform.WindowsPlayer or RuntimePlatform.WindowsServer
+                or RuntimePlatform.OSXPlayer or RuntimePlatform.OSXServer
+                or RuntimePlatform.LinuxPlayer or RuntimePlatform.LinuxServer => true,
+
+            // Mobile: false
+            RuntimePlatform.Android or RuntimePlatform.IPhonePlayer => false,
+
+            // Consoles: false
+            RuntimePlatform.GameCoreXboxSeries or RuntimePlatform.GameCoreXboxOne
+                or RuntimePlatform.PS4 or RuntimePlatform.PS5 or RuntimePlatform.Switch => false,
+
+            // Unknown platforms
+            _ => false
+        };
 
         if (application.ProductName is string productName
             && !string.IsNullOrWhiteSpace(productName)

test/Sentry.Unity.Tests/SentryUnityOptionsTests.cs

@@ -87,5 +87,29 @@ public void Ctor_Release_IgnoresDotOnlyProductNames()
     }
 
     [Test]
-    public void Ctor_IsEnvironmentUser_IsFalse() => Assert.AreEqual(false, _fixture.GetSut().IsEnvironmentUser);
+    [TestCase(RuntimePlatform.WindowsPlayer, true)]
+    [TestCase(RuntimePlatform.WindowsServer, true)]
+    [TestCase(RuntimePlatform.OSXPlayer, true)]
+    [TestCase(RuntimePlatform.OSXServer, true)]
+    [TestCase(RuntimePlatform.LinuxPlayer, true)]
+    [TestCase(RuntimePlatform.LinuxServer, true)]
+    [TestCase(RuntimePlatform.Android, false)]
+    [TestCase(RuntimePlatform.IPhonePlayer, false)]
+    [TestCase(RuntimePlatform.GameCoreXboxSeries, false)]
+    [TestCase(RuntimePlatform.GameCoreXboxOne, false)]
+    [TestCase(RuntimePlatform.PS4, false)]
+    [TestCase(RuntimePlatform.PS5, false)]
+    [TestCase(RuntimePlatform.Switch, false)]
+    [TestCase(RuntimePlatform.WindowsEditor, false)]
+    [TestCase(RuntimePlatform.OSXEditor, false)]
+    [TestCase(RuntimePlatform.LinuxEditor, false)]
+    [TestCase(RuntimePlatform.WebGLPlayer, false)]
+    public void Ctor_IsEnvironmentUser_DefaultsBasedOnPlatform(RuntimePlatform platform, bool expectedValue)
+    {
+        _fixture.Application.Platform = platform;
+
+        var sut = _fixture.GetSut();
+
+        Assert.AreEqual(expectedValue, sut.IsEnvironmentUser);
+    }
 }

test/Sentry.Unity.Tests/UnityEventScopeTests.cs

@@ -284,7 +284,7 @@ public void AppProtocol_Assigned()
     public void AppMemory_SetByEventProcessor()
     {
         // arrange
-        var unityEventProcessor = new UnityEventProcessor(_sentryOptions);
+        var unityEventProcessor = new UnityEventProcessor(_sentryOptions, new TestUnityInfo());
         var sentryEvent = new SentryEvent();
 
         // act
@@ -298,7 +298,7 @@ public void AppMemory_SetByEventProcessor()
     public void AppMemory_SetByEventProcessorForTransactions()
     {
         // arrange
-        var unityEventProcessor = new UnityEventProcessor(_sentryOptions);
+        var unityEventProcessor = new UnityEventProcessor(_sentryOptions, new TestUnityInfo());
         var transaction = new SentryTransaction("test-transaction", "test-operation");
 
         // act