Use obsolete attribute to display warning (#213)

backtrace-labs · May 9, 2024 · c97ed0a · c97ed0a
1 parent ccb82ca
commit c97ed0a
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 37 deletions.
diff --git a/Runtime/Attributes.meta b/Runtime/Attributes.meta
diff --git a/Runtime/Attributes/NotSupportedAttribute.cs b/Runtime/Attributes/NotSupportedAttribute.cs
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,5 +1,4 @@
-using Backtrace.Unity.Attributes;
-using Backtrace.Unity.Common;
+using Backtrace.Unity.Common;
 using Backtrace.Unity.Model.Breadcrumbs;
 using Backtrace.Unity.Services;
 using Backtrace.Unity.Types;
@@ -140,7 +139,7 @@ public class BacktraceConfiguration : ScriptableObject
         /// <summary>  
         /// Capture native crashes.
         /// </summary>
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public bool CaptureNativeCrashes = true;
 
@@ -150,7 +149,7 @@ public class BacktraceConfiguration : ScriptableObject
 #if UNITY_ANDROID || UNITY_IOS || UNITY_STANDALONE_WIN
         [Tooltip("Capture ANR events - Application not responding")]
 #else
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public bool HandleANR = true;
 
@@ -161,7 +160,7 @@ public class BacktraceConfiguration : ScriptableObject
 #if UNITY_ANDROID || UNITY_IOS || UNITY_STANDALONE_WIN
         [Tooltip("ANR watchdog timeout")]
 #else
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public int AnrWatchdogTimeout = DefaultAnrWatchdogTimeout;
 
@@ -171,7 +170,7 @@ public class BacktraceConfiguration : ScriptableObject
 #if UNITY_ANDROID || UNITY_IOS
         [Tooltip("Send Out of Memory exceptions to Backtrace")]
 #else
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public bool OomReports = false;
 
@@ -181,7 +180,7 @@ public class BacktraceConfiguration : ScriptableObject
 #if UNITY_2019_2_OR_NEWER && (UNITY_ANDROID || UNITY_IOS)
         [Tooltip("Enable client-side unwinding.")]
 #else
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public bool ClientSideUnwinding = false;
 
@@ -192,7 +191,7 @@ public class BacktraceConfiguration : ScriptableObject
 #if UNITY_2019_2_OR_NEWER && UNITY_ANDROID
         [Tooltip("Symbols upload token required to upload symbols to Backtrace")]
 #else
-        [NotSupported]
+        [Obsolete("Not supported")]
 #endif
         public string SymbolsUploadToken = string.Empty;
 

diff --git a/Tests/Runtime/BacktraceClientTests.cs b/Tests/Runtime/BacktraceClientTests.cs
@@ -19,13 +19,14 @@ public void Setup()
         }
 
         [UnityTest]
+        [Obsolete]
         public IEnumerator TestClientConfigurationOptions_ValidConfigurationWithAllOptions_AllowsToUseNotSupportedOptions()
         {
             var clientConfiguration = GetValidClientConfiguration();
-            clientConfiguration.OomReports = false;
             clientConfiguration.HandleANR = false;
             clientConfiguration.AnrWatchdogTimeout = 0;
             clientConfiguration.CaptureNativeCrashes = false;
+            clientConfiguration.OomReports = false;
             clientConfiguration.ClientSideUnwinding = false;
             clientConfiguration.SymbolsUploadToken = string.Empty;
             BacktraceClient.Configuration = clientConfiguration;