chore: Updated Samples (#2256)

Author: bitsandfoxes

samples/unity-of-bugs/Assets/Scenes/1_Bugfarm.unity renamed to samples/unity-of-bugs/Assets/Scenes/1_BugFarm.unity

@@ -1,13 +1,13 @@
-using System.Collections;
-using System.Threading;
+using System.Threading;
 using Sentry;
 using Sentry.Unity;
 using UnityEngine;
 
-public class AdditionalButtons : MonoBehaviour
+public class AdditionalSampleButtons : MonoBehaviour
 {
     public void SetUser()
     {
+        // Setting the user on the scope makes sure the user is set on the context of all future events
         SentrySdk.ConfigureScope(s =>
         {
             s.User = new SentryUser
@@ -20,7 +20,7 @@ public void SetUser()
         Debug.Log("User set: ant");
     }
 
-    class PlayerCharacter
+    private class PlayerCharacter
     {
         public string Name { get; set; }
         public int Age { get; set; }
@@ -29,7 +29,9 @@ class PlayerCharacter
 
     public void CaptureMessageWithContext()
     {
-        SentrySdk.ConfigureScope(scope =>
+        // The context is freely customizable and allows you to add data specific to your game.
+        // The SDKs capture methods provide an optional scope that is only getting applied for that one specific event
+        SentrySdk.CaptureMessage("Capturing with player character context.", scope =>
         {
             scope.Contexts["character"] = new PlayerCharacter
             {
@@ -38,30 +40,14 @@ public void CaptureMessageWithContext()
                 AttackType = "melee"
             };
         });
-
-        SentrySdk.CaptureMessage("Capturing with player character context.");
-        SentrySdk.ConfigureScope(scope => scope.Contexts = null);
     }
 
-    public void CaptureMessageWithScreenshot() => StartCoroutine(CaptureScreenshot());
-
     public void ApplicationNotResponding()
     {
         Debug.Log("Running Thread.Sleep() on the UI thread to trigger an ANR event.");
         Thread.Sleep(6 * 1000); // ANR detection currently defaults to 5 seconds
         Debug.Log("Thread.Sleep() finished.");
     }
 
-    private IEnumerator CaptureScreenshot()
-    {
-        yield return new WaitForEndOfFrame();
-        SentrySdk.ConfigureScope(s =>
-        {
-            var screenshot = ScreenCapture.CaptureScreenshotAsTexture();
-            s.AddAttachment(screenshot.EncodeToJPG(), "screenshot.jpg");
-        });
-
-        SentrySdk.CaptureMessage("Captured a message with a screenshot attachment");
-        SentrySdk.ConfigureScope(scope => scope.ClearAttachments());
-    }
+    public void Assert() => UnityEngine.Assertions.Assert.IsTrue(false);
 }

samples/unity-of-bugs/Assets/Scenes/1_Bugfarm.unity.meta renamed to samples/unity-of-bugs/Assets/Scenes/1_BugFarm.unity.meta

@@ -1,95 +1,98 @@
 using System;
 using System.Runtime.CompilerServices;
-using Sentry;
 using Sentry.Unity;
 using UnityEngine;
-using UnityEngine.Assertions;
 
 public class BugFarmButtons : MonoBehaviour
 {
     private void Awake()
     {
-        Debug.Log("Sample 🐛");
+        Debug.Log("The 🐛s awaken!");
     }
 
     private void Start()
     {
-        Debug.Log("Sample Start 🦋");
+        // Log messages are getting captured as breadcrumbs
+        Debug.Log("Starting the 🦋-Farm");
         Debug.LogWarning("Here come the bugs 🐞🦋🐛🐜🕷!");
     }
 
-    public void AssertFalse() => Assert.AreEqual(true, false);
-
-    [MethodImpl(MethodImplOptions.NoInlining)]
-    public void ThrowNull() => throw new NullReferenceException();
+    public void ThrowUnhandledException()
+    {
+        Debug.Log("Throwing a unhandled 🕷 exception!");
+        DoSomeWorkHere();
+    }
 
-    public void ThrowExceptionAndCatch()
+    public void ThrowExceptionButCatch()
     {
-        Debug.Log("Throwing an instance of 🐛 CustomException!");
+        Debug.Log("Throwing an exception but catching it! 🐜");
 
         try
         {
-            throw new CustomException("Custom bugs 🐛🐛🐛🐛.");
+            DoSomeWorkHere();
         }
         catch (Exception e)
         {
             SentrySdk.CaptureException(e);
         }
     }
 
-    public void ThrowNullAndCatch()
+    private void DoSomeWorkHere()
     {
-        Debug.Log("Throwing 'null' and catching 🐜🐜🐜 it!");
-
-        try
+        if (CheckSomeFakeWork())
         {
-            ThrowNull();
-        }
-        catch (Exception e)
-        {
-            SentrySdk.CaptureException(e);
+            DoSomeWorkThere();
         }
     }
 
-    public void CaptureMessage() => SentrySdk.CaptureMessage("🕷️🕷️🕷️ Spider message 🕷️🕷️🕷️🕷️");
-
-    // IL2CPP inlines this anyway :( - so we're adding some fake work to prevent the compiler from optimizing too much
-    [MethodImpl(MethodImplOptions.NoInlining)]
-    private void StackTraceExampleB()
+    private void DoSomeWorkThere()
     {
-        var someWork = DateTime.Now.ToString();
-        if (someWork.Length > 0)  // This condition will always be true but compiler can't be certain
+        if (CheckSomeFakeWork())
         {
-            throw new InvalidOperationException("Exception from a lady beetle 🐞");
+            throw new CustomException("Exception from an exceptional lady beetle 🐞!");
         }
     }
 
-    // IL2CPP inlines this anyway :( - so we're adding some fake work to prevent the compiler from optimizing too much
-    [MethodImpl(MethodImplOptions.NoInlining)]
-    public void StackTraceExampleA()
+    public void CaptureMessage()
     {
-        var someWork = DateTime.Now.ToString();
-        if (someWork.Length > 0)  // This condition will always be true but compiler can't be certain
+        if (CheckSomeFakeWork())
         {
-            StackTraceExampleB();
+            // Messages do not have a stacktrace attached by default. This is an opt-in feature.
+            // Note: That stack traces generated for message events are provided without line numbers. See known limitations
+            // https://docs.sentry.io/platforms/unity/troubleshooting/known-limitations/#line-numbers-missing-in-events-captured-through-debuglogerror-or-sentrysdkcapturemessage
+            SentrySdk.CaptureMessage("🕷️🕷️🕷️ Spider message 🕷️🕷️🕷️🕷️");
         }
     }
 
-    // IL2CPP inlines this anyway :( - so we're adding some fake work to prevent the compiler from optimizing too much
-    [MethodImpl(MethodImplOptions.NoInlining)]
     public void LogError()
     {
-        var someWork = DateTime.Now.ToString();
-        if (someWork.Length > 0)  // This condition will always be true but compiler can't be certain
+        if (CheckSomeFakeWork())
         {
+            // Error logs get captured as messages and do not have a stacktrace attached by default. This is an opt-in feature.
+            // Note: That stack traces generated for message events are provided without line numbers. See known limitations
+            // https://docs.sentry.io/platforms/unity/troubleshooting/known-limitations/#line-numbers-missing-in-events-captured-through-debuglogerror-or-sentrysdkcapturemessage
             Debug.LogError("Debug.LogError() called");
         }
     }
-}
 
-public class CustomException : Exception
-{
-    public CustomException(string message) : base(message)
+    public void LogException()
+    {
+        if (CheckSomeFakeWork())
+        {
+            // Error logs get captured as messages and do not have a stacktrace attached by default. This is an opt-in feature.
+            Debug.LogException(new NullReferenceException("Some bugs are harder to catch than others. 🦋"));
+        }
+    }
+
+    // NoInlining ends up being inlined through L2CPP anyway. :(
+    // We're checking some fake work here to prevent too aggressive optimization. That way, we can show off some proper
+    // stack traces that are closer to real-world bugs and events.
+    [MethodImpl(MethodImplOptions.NoInlining)]
+    private static bool CheckSomeFakeWork() => DateTime.Now.Ticks > 0; // Always true but not optimizable
+
+    private class CustomException : Exception
     {
+        public CustomException(string message) : base(message)
+        { }
     }
 }