feat: Xbox Native Support (#2314)

Author: bitsandfoxes

CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## Unreleased
 
-### Fixes 
+### Features
+
+- Added Xbox Native Support ([#2314](https://github.com/getsentry/sentry-unity/pull/2314))
+
+### Fixes
 
 - Fixed input handling in samples to work with old and new input system ([#2319](https://github.com/getsentry/sentry-unity/pull/2319))
 

package-dev/Runtime/SentryInitialization.cs

@@ -5,6 +5,8 @@
 #define SENTRY_NATIVE_ANDROID
 #elif UNITY_64 && (UNITY_STANDALONE_WIN || UNITY_STANDALONE_LINUX)
 #define SENTRY_NATIVE
+#elif UNITY_GAMECORE
+#define SENTRY_NATIVE
 #elif UNITY_WEBGL
 #define SENTRY_WEBGL
 #endif

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

@@ -91,6 +91,8 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti
         EditorGUI.indentLevel++;
         if (UnfoldNativeOptions)
         {
+            GUILayout.Label("Desktop", EditorStyles.boldLabel);
+
             options.WindowsNativeSupportEnabled = EditorGUILayout.Toggle(
                 new GUIContent("Windows", "Whether to enable native crashes support on Windows."),
                 options.WindowsNativeSupportEnabled);
@@ -103,6 +105,8 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti
                 new GUIContent("Linux", "Whether to enable native crashes support on Linux."),
                 options.LinuxNativeSupportEnabled);
 
+            GUILayout.Label("Mobile", EditorStyles.boldLabel);
+
             options.IosNativeSupportEnabled = EditorGUILayout.Toggle(
                 new GUIContent("iOS", "Whether to enable Native iOS support to capture" +
                                                      "errors written in languages such as Objective-C, Swift, C and C++."),
@@ -133,6 +137,12 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti
             EditorGUI.EndDisabledGroup();
             EditorGUI.EndDisabledGroup();
             EditorGUI.indentLevel--;
+
+            GUILayout.Label("Console", EditorStyles.boldLabel);
+
+            options.XboxNativeSupportEnabled = EditorGUILayout.Toggle(
+                new GUIContent("Xbox", "Whether to enable native crashes support on Xbox."),
+                options.XboxNativeSupportEnabled);
         }
 
         EditorGUI.indentLevel--;

src/Sentry.Unity.Editor/Native/BuildPostProcess.cs

@@ -18,7 +18,7 @@ public static class BuildPostProcess
     public static void OnPostProcessBuild(BuildTarget target, string executablePath)
     {
         var targetGroup = BuildPipeline.GetBuildTargetGroup(target);
-        if (targetGroup is not BuildTargetGroup.Standalone)
+        if (targetGroup is not BuildTargetGroup.Standalone and not BuildTargetGroup.GameCoreXboxSeries)
         {
             return;
         }
@@ -77,6 +77,7 @@ public static void OnPostProcessBuild(BuildTarget target, string executablePath)
         BuildTarget.StandaloneWindows64 => options.WindowsNativeSupportEnabled,
         BuildTarget.StandaloneOSX => options.MacosNativeSupportEnabled,
         BuildTarget.StandaloneLinux64 => options.LinuxNativeSupportEnabled,
+        BuildTarget.GameCoreXboxSeries or BuildTarget.GameCoreXboxOne => options.XboxNativeSupportEnabled,
         _ => false,
     };
 
@@ -94,6 +95,10 @@ private static void AddCrashHandler(IDiagnosticLogger logger, BuildTarget target
             case BuildTarget.StandaloneOSX:
                 // No standalone crash handler for Linux/macOS - uses built-in handlers.
                 return;
+            case BuildTarget.GameCoreXboxSeries:
+            case BuildTarget.GameCoreXboxOne:
+                // TODO: Figure out if we need to ship with a crash handler
+                return;
             default:
                 throw new ArgumentException($"Unsupported build target: {target}");
         }

src/Sentry.Unity/Il2CppEventProcessor.cs

@@ -361,7 +361,9 @@ is RuntimePlatform.Android
             or RuntimePlatform.LinuxPlayer
             or RuntimePlatform.LinuxServer
             or RuntimePlatform.WindowsPlayer
-            or RuntimePlatform.WindowsServer;
+            or RuntimePlatform.WindowsServer
+            or RuntimePlatform.GameCoreXboxSeries
+            or RuntimePlatform.GameCoreXboxOne;
     }
 
     private string GetPlatformDebugImageType(RuntimePlatform? platform = null)
@@ -379,6 +381,8 @@ private string GetPlatformDebugImageType(RuntimePlatform? platform = null)
                 return "macho";
             case RuntimePlatform.WindowsPlayer:
             case RuntimePlatform.WindowsServer:
+            case RuntimePlatform.GameCoreXboxSeries:
+            case RuntimePlatform.GameCoreXboxOne:
                 return "pe";
             default:
                 return "unknown";

src/Sentry.Unity/Integrations/UnityScopeIntegration.cs

@@ -3,6 +3,7 @@
 using Sentry.Reflection;
 using Sentry.Integrations;
 using Sentry.Unity.Integrations;
+using UnityEngine;
 using OperatingSystem = Sentry.Protocol.OperatingSystem;
 
 namespace Sentry.Unity;
@@ -78,9 +79,18 @@ private void PopulateApp(App app)
         app.BuildType = isDebugBuild is null ? null : (isDebugBuild.Value ? "debug" : "release");
     }
 
-    private void PopulateOperatingSystem(OperatingSystem operatingSystem)
+    private void PopulateOperatingSystem(OperatingSystem operatingSystemContext)
     {
-        operatingSystem.RawDescription = MainThreadData.OperatingSystem;
+        if (ApplicationAdapter.Instance.Platform
+            is RuntimePlatform.GameCoreXboxSeries
+            or RuntimePlatform.GameCoreXboxOne)
+        {
+            operatingSystemContext.Name = "Xbox";
+        }
+        else
+        {
+            operatingSystemContext.RawDescription = MainThreadData.OperatingSystem;
+        }
     }
 
     private void PopulateDevice(Device device)

src/Sentry.Unity/ScriptableSentryUnityOptions.cs

@@ -103,7 +103,7 @@ public static string GetConfigPath(string? notDefaultConfigName = null)
     [field: SerializeField] public bool WindowsNativeSupportEnabled { get; set; } = true;
     [field: SerializeField] public bool MacosNativeSupportEnabled { get; set; } = true;
     [field: SerializeField] public bool LinuxNativeSupportEnabled { get; set; } = true;
-
+    [field: SerializeField] public bool XboxNativeSupportEnabled { get; set; } = true;
     [field: SerializeField] public bool Il2CppLineNumberSupportEnabled { get; set; } = true;
 
     [field: SerializeField] public SentryRuntimeOptionsConfiguration? RuntimeOptionsConfiguration { get; set; }
@@ -185,6 +185,7 @@ internal SentryUnityOptions ToSentryUnityOptions(
             WindowsNativeSupportEnabled = WindowsNativeSupportEnabled,
             MacosNativeSupportEnabled = MacosNativeSupportEnabled,
             LinuxNativeSupportEnabled = LinuxNativeSupportEnabled,
+            XboxNativeSupportEnabled = XboxNativeSupportEnabled,
             Il2CppLineNumberSupportEnabled = Il2CppLineNumberSupportEnabled,
             PerformanceAutoInstrumentationEnabled = AutoAwakeTraces,
         };

src/Sentry.Unity/SentryUnityOptions.cs

@@ -209,6 +209,11 @@ public sealed class SentryUnityOptions : SentryOptions
     /// </summary>
     public bool LinuxNativeSupportEnabled { get; set; } = true;
 
+    /// <summary>
+    /// Whether the SDK should add native support for Xbox
+    /// </summary>
+    public bool XboxNativeSupportEnabled { get; set; } = true;
+
     /// <summary>
     /// Whether the SDK should add IL2CPP line number support
     /// </summary>
@@ -393,16 +398,18 @@ internal static bool IsKnownPlatform(RuntimePlatform? platform = null)
         return platform
             is RuntimePlatform.Android
             or RuntimePlatform.IPhonePlayer
-            or RuntimePlatform.WindowsEditor
-            or RuntimePlatform.WindowsPlayer
             or RuntimePlatform.OSXEditor
             or RuntimePlatform.OSXPlayer
+            or RuntimePlatform.OSXServer
+            or RuntimePlatform.WindowsEditor
+            or RuntimePlatform.WindowsPlayer
+            or RuntimePlatform.WindowsServer
             or RuntimePlatform.LinuxEditor
             or RuntimePlatform.LinuxPlayer
+            or RuntimePlatform.LinuxServer
             or RuntimePlatform.WebGLPlayer
-            or RuntimePlatform.WindowsServer
-            or RuntimePlatform.OSXServer
-            or RuntimePlatform.LinuxServer;
+            or RuntimePlatform.GameCoreXboxSeries
+            or RuntimePlatform.GameCoreXboxOne;
     }
 
     public override string ToString()

src/Sentry.Unity/SentryUnityOptionsExtensions.cs

@@ -58,6 +58,7 @@ internal static bool IsNativeSupportEnabled(this SentryUnityOptions options, Run
             RuntimePlatform.WindowsPlayer or RuntimePlatform.WindowsServer => options.WindowsNativeSupportEnabled,
             RuntimePlatform.OSXPlayer or RuntimePlatform.OSXServer => options.MacosNativeSupportEnabled,
             RuntimePlatform.LinuxPlayer or RuntimePlatform.LinuxServer => options.LinuxNativeSupportEnabled,
+            RuntimePlatform.GameCoreXboxSeries or RuntimePlatform.GameCoreXboxOne => options.XboxNativeSupportEnabled,
             _ => false
         };
     }