Allow defining not supported variables (#210)

* Allow defining not supported variables * Unit test
backtrace-labs · Apr 29, 2024 · afa3e05 · afa3e05
1 parent f57bae4
commit afa3e05
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 12 deletions.
diff --git a/Runtime/Attributes.meta b/Runtime/Attributes.meta
diff --git a/Runtime/Attributes/NotSupportedAttribute.cs b/Runtime/Attributes/NotSupportedAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace Backtrace.Unity.Attributes
+{
+    [Obsolete("Not supported")]
+    public class NotSupportedAttribute : Attribute
+    {
+    }
+}
diff --git a/Runtime/Attributes/NotSupportedAttribute.cs.meta b/Runtime/Attributes/NotSupportedAttribute.cs.meta
diff --git a/Runtime/Model/BacktraceConfiguration.cs b/Runtime/Model/BacktraceConfiguration.cs
@@ -1,4 +1,5 @@
-using Backtrace.Unity.Common;
+using Backtrace.Unity.Attributes;
+using Backtrace.Unity.Common;
 using Backtrace.Unity.Model.Breadcrumbs;
 using Backtrace.Unity.Services;
 using Backtrace.Unity.Types;
@@ -125,7 +126,6 @@ public class BacktraceConfiguration : ScriptableObject
         [Tooltip("Try to find game native crashes and send them on Game startup")]
         public bool SendUnhandledGameCrashesOnGameStartup = true;
 
-#if UNITY_ANDROID || UNITY_IOS || UNITY_STANDALONE_WIN || UNITY_GAMECORE_XBOXSERIES
 #if UNITY_ANDROID
         /// <summary>
         /// Capture native NDK Crashes.
@@ -136,47 +136,66 @@ public class BacktraceConfiguration : ScriptableObject
         /// Capture native crashes.
         /// </summary>
         [Tooltip("Capture native Crashes")]
+#else
+        /// <summary>  
+        /// Capture native crashes.
+        /// </summary>
+        [NotSupported]
 #endif
-
         public bool CaptureNativeCrashes = true;
-#if !UNITY_GAMECORE_XBOXSERIES
+
         /// <summary>
         /// Handle ANR events - Application not responding
         /// </summary>
+#if UNITY_ANDROID || UNITY_IOS || UNITY_STANDALONE_WIN
         [Tooltip("Capture ANR events - Application not responding")]
-        public bool HandleANR = true;
+#else
+        [NotSupported]
 #endif
+        public bool HandleANR = true;
+
 
         /// <summary>
         /// Anr watchdog timeout in ms. Time needed to detect an ANR event
         /// </summary>
+#if UNITY_ANDROID || UNITY_IOS || UNITY_STANDALONE_WIN
+        [Tooltip("ANR watchdog timeout")]
+#else
+        [NotSupported]
+#endif
         public int AnrWatchdogTimeout = DefaultAnrWatchdogTimeout;
 
-#if UNITY_ANDROID || UNITY_IOS
         /// <summary>
         /// Send Out of memory exceptions to Backtrace. 
         /// </summary>
+#if UNITY_ANDROID || UNITY_IOS
         [Tooltip("Send Out of Memory exceptions to Backtrace")]
+#else
+        [NotSupported]
+#endif
         public bool OomReports = false;
 
-#if UNITY_2019_2_OR_NEWER
         /// <summary>
         /// Enable client side unwinding.
         /// </summary>
+#if UNITY_2019_2_OR_NEWER && (UNITY_ANDROID || UNITY_IOS)
         [Tooltip("Enable client-side unwinding.")]
-        public bool ClientSideUnwinding = false;
+#else
+        [NotSupported]
 #endif
+        public bool ClientSideUnwinding = false;
 
-#endif
 
-#if UNITY_2019_2_OR_NEWER && UNITY_ANDROID
         /// <summary>
         /// Symbols upload token
         /// </summary>
+#if UNITY_2019_2_OR_NEWER && UNITY_ANDROID
         [Tooltip("Symbols upload token required to upload symbols to Backtrace")]
-        public string SymbolsUploadToken = string.Empty;
-#endif
+#else
+        [NotSupported]
 #endif
+        public string SymbolsUploadToken = string.Empty;
+
 
         /// <summary>
         /// Backtrace client deduplication strategy. 

diff --git a/Tests/Runtime/BacktraceClientTests.cs b/Tests/Runtime/BacktraceClientTests.cs
@@ -18,6 +18,22 @@ public void Setup()
             AfterSetup(false);
         }
 
+        [UnityTest]
+        public IEnumerator TestClientConfigurationOptions_ValidConfigurationWithAllOptions_AllowsToUseNotSupportedOptions()
+        {
+            var clientConfiguration = GetValidClientConfiguration();
+            clientConfiguration.OomReports = false;
+            clientConfiguration.HandleANR = false;
+            clientConfiguration.AnrWatchdogTimeout = 0;
+            clientConfiguration.CaptureNativeCrashes = false;
+            clientConfiguration.ClientSideUnwinding = false;
+            clientConfiguration.SymbolsUploadToken = string.Empty;
+            BacktraceClient.Configuration = clientConfiguration;
+            BacktraceClient.Refresh();
+            Assert.IsTrue(BacktraceClient.Enabled);
+            yield return null;
+        }
+
         [UnityTest]
         public IEnumerator TestClientCreation_ValidBacktraceConfiguration_ValidClientCreation()
         {