Rework Initialization

CHANGELOG.md

@@ -4,7 +4,18 @@
 
 ### Breaking Changes
 
-- Dropped support for Unity 2019. It reached End of Life in 2022 ([#2231](https://github.com/getsentry/sentry-unity/pull/2231))
+- Removed Unity 2019 support, which reached End of Life in 2022. Minimum supported version now is 2020 ([#2231](https://github.com/getsentry/sentry-unity/pull/2231))
+
+- **Breaking Change**: The Unity SDK's static API has been simplified moved from `Sentry.Unity.SentryUnity` and `Sentry.SentrySdk`
+  to `Sentry.Unity.SentrySdk`. 
+  This change enables manual SDK initialization with full functionality, previously only available through auto-initialization.
+  The underlying .NET SDK's `SentrySdk` class is now internal, and several previously public classes like `SentryInitialization` 
+  and `SentryIntegrations` are now internal.
+
+  **Migration**: Update your `using` directives from `using Sentry;` to `using Sentry.Unity;`. IDEs like Rider can automatically 
+  import the missing references. In some cases, you may need both `using Sentry.Unity;` (for the static API) and `using Sentry;` 
+  (for types like `SentryId`). No changes are required to your actual SDK method calls (e.g., `SentrySdk.CaptureException()` 
+  remains the same). ([#2227](https://github.com/getsentry/sentry-unity/pull/2227))
 
 ### Features
 

package-dev/Runtime/SentryInitialization.cs

@@ -15,7 +15,9 @@
 #endif
 
 using System;
+using Sentry.Unity;
 using Sentry.Extensibility;
+using Sentry.Unity.NativeUtils;
 #if UNITY_2020_3_OR_NEWER
 using System.Buffers;
 using System.Runtime.InteropServices;
@@ -39,91 +41,56 @@
 
 namespace Sentry.Unity
 {
-    public static class SentryInitialization
+    internal static class SentryInitialization
     {
-        public const string StartupTransactionOperation = "app.start";
-        public static ISpan InitSpan;
-        private const string InitSpanOperation = "runtime.init";
-        public static ISpan SubSystemRegistrationSpan;
-        private const string SubSystemSpanOperation = "runtime.init.subsystem";
-
+        /// <summary>
+        /// This is intended for internal use only.
+        /// The SDK relies on <c>SetupPlatformServices</c> getting called as the very first thing during the game's
+        /// startup. This ensures that features like line number and native support are set up and configured properly.
+        /// This is also the case when initializing manually from code.
+        /// </summary>
 #if SENTRY_WEBGL
         // On WebGL SubsystemRegistration is too early for the UnityWebRequestTransport and errors with 'URI empty'
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
 #else
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
 #endif
-        public static void Init()
+        private static void Init()
         {
-            var unityInfo = new SentryUnityInfo();
+            // We're setting up `UnityInfo` and the platform specific configure callbacks as the very first thing.
+            // These are required to be available during initialization.
+            SetupPlatformServices();
+
             // Loading the options invokes the ScriptableOption`Configure` callback. Users can disable the SDK via code.
-            var options = ScriptableSentryUnityOptions.LoadSentryUnityOptions(unityInfo);
+            var options = ScriptableSentryUnityOptions.LoadSentryUnityOptions();
             if (options != null && options.ShouldInitializeSdk())
             {
-                // Certain integrations require access to preprocessor directives so we provide them as `.cs` and
-                // compile them with the game instead of precompiling them with the rest of the SDK.
-                // i.e. SceneManagerAPI requires UNITY_2020_3_OR_NEWER
-                SentryIntegrations.Configure(options);
-                // Configures scope sync and (by default) initializes the native SDK.
-                SetupNativeSdk(options, unityInfo);
-                SentryUnity.Init(options);
-                SetupStartupTracing(options);
+                SentrySdk.Init(options);
             }
             else
             {
                 // If the SDK is not `enabled` we're closing down the native layer as well. This is especially relevant
                 // in a `built-time-initialization` scenario where the native SDKs self-initialize.
 #if SENTRY_NATIVE_COCOA
-                SentryNativeCocoa.Close(options, unityInfo);
+                SentryNativeCocoa.Close(options);
 #elif SENTRY_NATIVE_ANDROID
-                SentryNativeAndroid.Close(options, unityInfo);
+                SentryNativeAndroid.Close(options);
 #endif
             }
         }
 
-        private static void SetupNativeSdk(SentryUnityOptions options, SentryUnityInfo unityInfo)
+        private static void SetupPlatformServices()
         {
-            try
-            {
+            SentryPlatformServices.UnityInfo = new SentryUnityInfo();
+
 #if SENTRY_NATIVE_COCOA
-                SentryNativeCocoa.Configure(options, unityInfo);
+            SentryPlatformServices.PlatformConfiguration = SentryNativeCocoa.Configure;
 #elif SENTRY_NATIVE_ANDROID
-                SentryNativeAndroid.Configure(options, unityInfo);
+            SentryPlatformServices.PlatformConfiguration = SentryNativeAndroid.Configure;
 #elif SENTRY_NATIVE
-                SentryNative.Configure(options, unityInfo);
+            SentryPlatformServices.PlatformConfiguration = SentryNative.Configure;
 #elif SENTRY_WEBGL
-              SentryWebGL.Configure(options);
-#endif
-            }
-            catch (DllNotFoundException e)
-            {
-                options.DiagnosticLogger?.LogError(e,
-                    "Sentry native-error capture configuration failed to load a native library. This usually " +
-                    "means the library is missing from the application bundle or the installation directory.");
-            }
-            catch (Exception e)
-            {
-                options.DiagnosticLogger?.LogError(e, "Sentry native error capture configuration failed.");
-            }
-        }
-
-        private static void SetupStartupTracing(SentryUnityOptions options)
-        {
-#if !SENTRY_WEBGL
-            if (options.TracesSampleRate > 0.0f && options.AutoStartupTraces)
-            {
-                options.DiagnosticLogger?.LogInfo("Creating '{0}' transaction for runtime initialization.",
-                    StartupTransactionOperation);
-
-                var runtimeStartTransaction =
-                    SentrySdk.StartTransaction("runtime.initialization", StartupTransactionOperation);
-                SentrySdk.ConfigureScope(scope => scope.Transaction = runtimeStartTransaction);
-
-                options.DiagnosticLogger?.LogDebug("Creating '{0}' span.", InitSpanOperation);
-                InitSpan = runtimeStartTransaction.StartChild(InitSpanOperation, "runtime initialization");
-                options.DiagnosticLogger?.LogDebug("Creating '{0}' span.", SubSystemSpanOperation);
-                SubSystemRegistrationSpan = InitSpan.StartChild(SubSystemSpanOperation, "subsystem registration");
-            }
+            SentryPlatformServices.PlatformConfiguration = SentryWebGL.Configure;
 #endif
         }
     }

package-dev/Runtime/SentryUserFeedback.cs

@@ -86,7 +86,7 @@ public void SendFeedback()
             else
             {
                 // Since there is no screenshot added we can capture the feedback right away
-                SentryUnity.CaptureFeedback(_description.text, _email.text, _name.text, addScreenshot: false);
+                SentrySdk.CaptureFeedback(_description.text, _email.text, _name.text, addScreenshot: false);
             }
         }
 
@@ -99,7 +99,7 @@ private IEnumerator HideFormAndCaptureFeedback()
             // We're waiting for the EndOfFrame so the FeedbackForm gets updated before capturing the screenshot
             yield return new WaitForEndOfFrame();
 
-            SentryUnity.CaptureFeedback(_description.text, _email.text, _name.text, addScreenshot: true);
+            SentrySdk.CaptureFeedback(_description.text, _email.text, _name.text, addScreenshot: true);
 
             ResetUserFeedback();
         }

samples/unity-of-bugs/Assets/Resources/Sentry/SentryOptions.asset

@@ -19,7 +19,7 @@ MonoBehaviour:
   <DebounceTimeLog>k__BackingField: 1000
   <DebounceTimeWarning>k__BackingField: 1000
   <DebounceTimeError>k__BackingField: 1000
-  <TracesSampleRate>k__BackingField: 0
+  <TracesSampleRate>k__BackingField: 1
   <AutoStartupTraces>k__BackingField: 1
   <AutoSceneLoadTraces>k__BackingField: 1
   <AutoAwakeTraces>k__BackingField: 0

samples/unity-of-bugs/Assets/Scripts/AdditionalButtons.cs

@@ -1,7 +1,7 @@
 using System.Collections;
 using System.Threading;
-using System.Threading.Tasks;
 using Sentry;
+using Sentry.Unity;
 using UnityEngine;
 
 public class AdditionalButtons : MonoBehaviour

samples/unity-of-bugs/Assets/Scripts/BugFarmButtons.cs

@@ -1,7 +1,7 @@
 using System;
-using System.Globalization;
 using System.Runtime.CompilerServices;
 using Sentry;
+using Sentry.Unity;
 using UnityEngine;
 using UnityEngine.Assertions;
 

samples/unity-of-bugs/Assets/Scripts/NativeSupport/NativeButtons.cs

@@ -1,7 +1,7 @@
-using Sentry;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
+using Sentry.Unity;
 using UnityEngine;
 using UnityEngine.Diagnostics;
 using UnityEngine.UI;

samples/unity-of-bugs/Assets/Scripts/ThreadingSamples.cs

@@ -3,7 +3,7 @@
 using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
-using Sentry;
+using Sentry.Unity;
 using UnityEngine;
 using UnityEngine.Assertions;
 

src/Sentry.Unity.Android/SentryNativeAndroid.cs

@@ -1,6 +1,7 @@
 using System;
 using Sentry.Extensibility;
 using Sentry.Unity.Integrations;
+using Sentry.Unity.NativeUtils;
 using UnityEngine;
 using UnityEngine.Analytics;
 
@@ -19,7 +20,10 @@ public static class SentryNativeAndroid
     /// Configures the native Android support.
     /// </summary>
     /// <param name="options">The Sentry Unity options to use.</param>
-    public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentryUnityInfo)
+    public static void Configure(SentryUnityOptions options) =>
+        Configure(options, SentryPlatformServices.UnityInfo);
+
+    internal static void Configure(SentryUnityOptions options, ISentryUnityInfo? sentryUnityInfo)
     {
         MainThreadData.CollectData();
 
@@ -105,7 +109,7 @@ public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentry
                 e, "Failed to reinstall backend. Captured native crashes will miss scope data and tag.");
         }
 
-        options.NativeSupportCloseCallback = () => Close(options, sentryUnityInfo);
+        options.NativeSupportCloseCallback = () => Close(options);
 
         options.DiagnosticLogger?.LogDebug("Fetching installation ID");
 
@@ -136,14 +140,14 @@ public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentry
     /// <summary>
     /// Closes the native Android support.
     /// </summary>
-    public static void Close(SentryUnityOptions options, ISentryUnityInfo sentryUnityInfo) =>
-        Close(options, sentryUnityInfo, ApplicationAdapter.Instance.Platform);
+    public static void Close(SentryUnityOptions options) =>
+        Close(options, SentryPlatformServices.UnityInfo, ApplicationAdapter.Instance.Platform);
 
-    internal static void Close(SentryUnityOptions options, ISentryUnityInfo sentryUnityInfo, RuntimePlatform platform)
+    internal static void Close(SentryUnityOptions options, ISentryUnityInfo? sentryUnityInfo, RuntimePlatform platform)
     {
         options.DiagnosticLogger?.LogInfo("Attempting to close the Android SDK");
 
-        if (!sentryUnityInfo.IsNativeSupportEnabled(options, platform))
+        if (!sentryUnityInfo?.IsNativeSupportEnabled(options, platform) ?? false)
         {
             options.DiagnosticLogger?.LogDebug("Android Native Support is not enabled. Skipping closing the Android SDK");
             return;