fix: Validating options before SDK init (#370)

* added options validity check before init

* add logger before validate

* moved validation right before initializing the sdk

* updated CHANGELOG.md

* tweaked and added tests

* improved tests

* clarifying prebuild message

Author: bitsandfoxes

Diff for: CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- CaptureInEditor flag fixed for programmatic initialization ([#370](https://github.com/getsentry/sentry-unity/pull/370))
 - Preventing numeric options to be set negative in the editor window ([#364](https://github.com/getsentry/sentry-unity/pull/364))
 
 

Diff for: src/Sentry.Unity/SentryUnity.cs

@@ -12,28 +12,30 @@ public static class SentryUnity
         /// <summary>
         /// Initializes Sentry Unity SDK while configuring the options.
         /// </summary>
-        /// <param name="unitySentryOptionsConfigure">Callback to configure the options.</param>
-        public static void Init(Action<SentryUnityOptions> unitySentryOptionsConfigure)
+        /// <param name="sentryUnityOptionsConfigure">Callback to configure the options.</param>
+        public static void Init(Action<SentryUnityOptions> sentryUnityOptionsConfigure)
         {
-            var unitySentryOptions = new SentryUnityOptions();
-            SentryOptionsUtility.SetDefaults(unitySentryOptions);
+            var sentryUnityOptions = new SentryUnityOptions();
+            SentryOptionsUtility.SetDefaults(sentryUnityOptions);
 
-            unitySentryOptionsConfigure.Invoke(unitySentryOptions);
+            sentryUnityOptionsConfigure.Invoke(sentryUnityOptions);
 
-            SentryOptionsUtility.TryAttachLogger(unitySentryOptions);
-            Init(unitySentryOptions);
+            SentryOptionsUtility.TryAttachLogger(sentryUnityOptions);
+            Init(sentryUnityOptions);
         }
 
         /// <summary>
         /// Initializes Sentry Unity SDK while providing an options object.
         /// </summary>
-        /// <param name="unitySentryOptions">The options object.</param>
+        /// <param name="sentryUnityOptions">The options object.</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public static void Init(SentryUnityOptions unitySentryOptions)
+        public static void Init(SentryUnityOptions sentryUnityOptions)
         {
-            unitySentryOptions.DiagnosticLogger?.LogDebug(unitySentryOptions.ToString());
-
-            SentrySdk.Init(unitySentryOptions);
+            if (sentryUnityOptions.ShouldInitializeSdk())
+            {
+                sentryUnityOptions.DiagnosticLogger?.LogDebug(sentryUnityOptions.ToString());
+                SentrySdk.Init(sentryUnityOptions);
+            }
         }
     }
 }

Diff for: test/Sentry.Unity.Tests/IntegrationTests.cs

@@ -224,7 +224,7 @@ public IEnumerator Init_OptionsAreDefaulted()
             SentryUnityOptions? actualOptions = null;
             using var _ = InitSentrySdk(o =>
             {
-                o.Dsn = null; // InitSentrySDK already sets a test dsn
+                o.Dsn = string.Empty; // InitSentrySDK already sets a test dsn
                 actualOptions = o;
             });
 

Diff for: test/Sentry.Unity.Tests/SentryUnityTests.cs

@@ -0,0 +1,71 @@
+using System;
+using NUnit.Framework;
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace Sentry.Unity.Tests
+{
+    [TestFixture]
+    public class SentryUnityTests : IPrebuildSetup, IPostBuildCleanup
+    {
+        // If an options scriptable object exists Sentry SDK initializes itself on 'BeforeSceneLoad'.
+        // We check in prebuild if those options exist and are enabled, disable them and restore them on Cleanup
+        private ScriptableSentryUnityOptions? _optionsToRestore;
+
+        public void Setup()
+        {
+            var options = AssetDatabase.LoadAssetAtPath(ScriptableSentryUnityOptions.GetConfigPath(ScriptableSentryUnityOptions.ConfigName),
+                typeof(ScriptableSentryUnityOptions)) as ScriptableSentryUnityOptions;
+            if (options?.Enabled != true)
+            {
+                return;
+            }
+
+            Debug.Log("Disabling local options for the duration of the test.");
+            _optionsToRestore = options;
+            _optionsToRestore.Enabled = false;
+        }
+
+        public void Cleanup()
+        {
+            if (_optionsToRestore != null)
+            {
+                _optionsToRestore.Enabled = true;
+            }
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            if (SentrySdk.IsEnabled)
+            {
+                SentrySdk.Close();
+            }
+        }
+
+        [Test]
+        public void SentryUnity_OptionsValid_Initializes()
+        {
+            var options = new SentryUnityOptions();
+            SentryOptionsUtility.SetDefaults(options);
+            options.Dsn = "https://[email protected]/5439417";
+
+            SentryUnity.Init(options);
+
+            Assert.IsTrue(SentrySdk.IsEnabled);
+        }
+
+        [Test]
+        public void SentryUnity_OptionsInvalid_DoesNotInitialize()
+        {
+            var options = new SentryUnityOptions();
+            SentryOptionsUtility.SetDefaults(options);
+
+            // Even tho the defaults are set the DSN is missing making the options invalid for initialization
+            SentryUnity.Init(options);
+
+            Assert.IsFalse(SentrySdk.IsEnabled);
+        }
+    }
+}