Rework Initialization

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;
@@ -37,9 +39,9 @@
 
 [assembly: AlwaysLinkAssembly]
 
-namespace Sentry.Unity
+namespace Sentry.Internal.Unity
 {
-    public static class SentryInitialization
+    internal static class SentryInitialization
     {
         public const string StartupTransactionOperation = "app.start";
         public static ISpan InitSpan;
@@ -53,58 +55,49 @@ public static class SentryInitialization
 #else
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
 #endif
-        public static void Init()
+        internal static void Init()
         {
-            var unityInfo = new SentryUnityInfo();
+            // We're setting up `UnityInfo` and the platform specific configure callbacks as the very first thing to be
+            // available during initialization.
+            SetupPlatformConfiguration();
+
             // 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.
+                // compile them with the game instead of pre-compiling them with the rest of the SDK.
                 // i.e. SceneManagerAPI requires UNITY_2020_3_OR_NEWER
+                // TODO: Find a way to move this into `SentrySdk.Init` too
                 SentryIntegrations.Configure(options);
-                // Configures scope sync and (by default) initializes the native SDK.
-                SetupNativeSdk(options, unityInfo);
-                SentryUnity.Init(options);
+
+                SentrySdk.Init(options);
                 SetupStartupTracing(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, SentryPlatformServices.UnityInfo);
 #elif SENTRY_NATIVE_ANDROID
-                SentryNativeAndroid.Close(options, unityInfo);
+                SentryNativeAndroid.Close(options, SentryPlatformServices.UnityInfo);
 #endif
             }
         }
 
-        private static void SetupNativeSdk(SentryUnityOptions options, SentryUnityInfo unityInfo)
+        private static void SetupPlatformConfiguration()
         {
-            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.");
-            }
         }
 
         private static void SetupStartupTracing(SentryUnityOptions options)

package-dev/Runtime/SentryIntegrations.cs

@@ -10,10 +10,11 @@
 
 using Sentry.Extensibility;
 using Sentry.Integrations;
+using Sentry.Unity;
 using UnityEngine;
 using UnityEngine.SceneManagement;
 
-namespace Sentry.Unity
+namespace Sentry.Internal.Unity
 {
     public static class SentryIntegrations
     {

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

package-dev/Tests/Runtime/SentryIntegrationsTests.cs

@@ -5,7 +5,7 @@
 using System;
 using System.Collections;
 using NUnit.Framework;
-using Sentry.Unity.Tests;
+using Sentry.Internal.Unity;
 using UnityEngine.SceneManagement;
 using UnityEngine.TestTools;
 
@@ -52,7 +52,7 @@ public IEnumerator Configure_TranceSampleRateOne_AddsSceneManagerTracingIntegrat
 
         public static IDisposable InitSentrySdk(SentryUnityOptions options)
         {
-            SentryUnity.Init(options);
+            SentrySdk.Init(options);
             return new SentryDisposable();
         }
 

package-dev/Tests/Runtime/SentrySceneTracingIntegrationTests.cs

@@ -5,8 +5,8 @@
 using System;
 using System.Collections;
 using NUnit.Framework;
+using Sentry.Internal.Unity;
 using Sentry.Unity.Tests;
-using UnityEngine;
 using UnityEngine.SceneManagement;
 using UnityEngine.TestTools;
 

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,15 +1,17 @@
 using System;
-using System.Globalization;
 using System.Runtime.CompilerServices;
-using Sentry;
+using Sentry.Unity;
 using UnityEngine;
 using UnityEngine.Assertions;
 
+
 public class BugFarmButtons : MonoBehaviour
 {
     private void Awake()
     {
         Debug.Log("Sample 🐛");
+
+        SentrySdk.Init(options => {});
     }
 
     private void Start()

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/NativeUtils/SentryPlatformServices.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace Sentry.Unity.NativeUtils;
+
+public static class SentryPlatformServices
+{
+    public static ISentryUnityInfo? UnityInfo { get; set; }
+    public static Action<SentryUnityOptions, ISentryUnityInfo>? PlatformConfiguration { get; set; }
+}

src/Sentry.Unity/ScriptableSentryUnityOptions.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using Sentry.Extensibility;
 using Sentry.Unity.Integrations;
+using Sentry.Unity.NativeUtils;
 using UnityEngine;
 
 namespace Sentry.Unity;
@@ -120,12 +121,12 @@ public static string GetConfigPath(string? notDefaultConfigName = null)
     /// <remarks>
     /// Used for loading the SentryUnityOptions from the ScriptableSentryUnityOptions during runtime.
     /// </remarks>
-    public static SentryUnityOptions? LoadSentryUnityOptions(ISentryUnityInfo unityInfo)
+    public static SentryUnityOptions? LoadSentryUnityOptions()
     {
         var scriptableOptions = Resources.Load<ScriptableSentryUnityOptions>($"{ConfigRootFolder}/{ConfigName}");
         if (scriptableOptions is not null)
         {
-            return scriptableOptions.ToSentryUnityOptions(false, unityInfo);
+            return scriptableOptions.ToSentryUnityOptions(false, SentryPlatformServices.UnityInfo);
         }
 
         return null;

src/Sentry.Unity/SentryMonoBehaviour.cs

@@ -39,9 +39,9 @@ public static SentryMonoBehaviour Instance
 public partial class SentryMonoBehaviour
 {
     public void StartAwakeSpan(MonoBehaviour monoBehaviour) =>
-        SentrySdk.GetSpan()?.StartChild("awake", $"{monoBehaviour.gameObject.name}.{monoBehaviour.GetType().Name}");
+        Sentry.SentrySdk.GetSpan()?.StartChild("awake", $"{monoBehaviour.gameObject.name}.{monoBehaviour.GetType().Name}");
 
-    public void FinishAwakeSpan() => SentrySdk.GetSpan()?.Finish(SpanStatus.Ok);
+    public void FinishAwakeSpan() => Sentry.SentrySdk.GetSpan()?.Finish(SpanStatus.Ok);
 }
 
 /// <summary>