Rework Initialization (#2227)

Author: bitsandfoxes

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/programatic SDK initialization](https://docs.sentry.io/platforms/unity/configuration/options/programmatic-configuration/) 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/Editor/SentryEditorPlatformSetUp.cs

@@ -0,0 +1,28 @@
+using UnityEditor;
+using UnityEngine;
+using System;
+using Sentry.Unity;
+using Sentry.Unity.NativeUtils;
+
+namespace Sentry.Unity.Editor
+{
+    internal static class SentryEditorPlatformSetUp
+    {
+        /// <summary>
+        /// Called by Unity during domain reloads in the editor and before builds.
+        /// This ensures that platform services are available during build-time processing.
+        /// </summary>
+        [InitializeOnLoadMethod]
+        private static void SetUpUnityInfoInEditor()
+        {
+            try
+            {
+                _ = SentryPlatformServices.UnityInfo;
+            }
+            catch (InvalidOperationException)
+            {
+                SentryPlatformServices.UnityInfo = new SentryUnityInfo();
+            }
+        }
+    }
+}

package-dev/Editor/SentryEditorPlatformSetUp.cs.meta

@@ -0,0 +1,18 @@
+{
+    "name": "io.sentry.unity.dev.editor",
+    "rootNamespace": "",
+    "references": [
+        "GUID:c18c74693c5844315b1f3cd5ae87afb4"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

package-dev/Editor/io.sentry.unity.dev.editor.asmdef

@@ -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,61 +41,57 @@
 
 namespace Sentry.Unity
 {
-    public static class SentryInitialization
+    internal static class SentryInitialization
     {
+        /// <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())
             {
-                // Configures scope sync and (by default) initializes the native SDK.
-                SetupNativeSdk(options, unityInfo);
-                SentryUnity.Init(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);
+            SentryPlatformServices.PlatformConfiguration = SentryWebGL.Configure;
 #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.");
-            }
         }
     }
 

package-dev/Editor/io.sentry.unity.dev.editor.asmdef.meta

@@ -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();
         }

package-dev/Runtime/SentryInitialization.cs

@@ -1,8 +1,7 @@
 {
     "name": "io.sentry.unity.dev.runtime",
-    "references": [
-        ""
-    ],
+    "rootNamespace": "",
+    "references": [],
     "includePlatforms": [
         "Android",
         "Editor",

package-dev/Runtime/SentryUserFeedback.cs

@@ -0,0 +1,18 @@
+{
+    "name": "io.sentry.unity.editor",
+    "rootNamespace": "",
+    "references": [
+        "GUID:c18c74693c5844315b1f3cd5ae87afb4"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}