feat: Added GetLastRunState to the SentryUnity (#2049)

Author: bitsandfoxes

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Added `SentryUnity.CrashedLastRun()`. This allows you to check whether the SDK captured a crash the last time the game ran. ([#2049](https://github.com/getsentry/sentry-unity/pull/2049))
+
 ### Fixes
 
 - Fixed a potential race condition in the ANR watchdog integration ([2045](https://github.com/getsentry/sentry-unity/pull/2045))

src/Sentry.Unity/SentryUnity.cs

@@ -47,4 +47,42 @@ public static void Close()
         UnitySdk?.Close();
         UnitySdk = null;
     }
+
+    /// <summary>
+    /// Represents the crash state of the games's previous run.
+    /// Used to determine if the last execution terminated normally or crashed.
+    /// </summary>
+    public enum CrashedLastRun
+    {
+        /// <summary>
+        /// The LastRunState is unknown. This might be due to the SDK not being initialized, native crash support
+        /// missing, or being disabled.
+        /// </summary>
+        Unknown,
+
+        /// <summary>
+        /// The application did not crash during the last run.
+        /// </summary>
+        DidNotCrash,
+
+        /// <summary>
+        /// The application crashed during the last run.
+        /// </summary>
+        Crashed
+    }
+
+    /// <summary>
+    /// Retrieves the crash state of the previous application run.
+    /// This indicates whether the application terminated normally or crashed.
+    /// </summary>
+    /// <returns><see cref="CrashedLastRun"/> indicating the state of the previous run.</returns>
+    public static CrashedLastRun GetLastRunState()
+    {
+        if (UnitySdk is null)
+        {
+            return CrashedLastRun.Unknown;
+        }
+
+        return UnitySdk.CrashedLastRun();
+    }
 }

src/Sentry.Unity/SentryUnitySDK.cs

@@ -99,4 +99,18 @@ public void Close()
                 "Exception while releasing the lockfile on the config directory.", ex);
         }
     }
+
+    public SentryUnity.CrashedLastRun CrashedLastRun()
+    {
+        if (_options.CrashedLastRun is null)
+        {
+            _options.DiagnosticLogger?.LogDebug("The SDK does not have a 'CrashedLastRun' set. " +
+                                                "This might be due to a missing or disabled native integration.");
+            return SentryUnity.CrashedLastRun.Unknown;
+        }
+
+        return _options.CrashedLastRun.Invoke()
+            ? SentryUnity.CrashedLastRun.Crashed
+            : SentryUnity.CrashedLastRun.DidNotCrash;
+    }
 }

test/Sentry.Unity.Tests/SentryUnityTests.cs

@@ -11,6 +11,8 @@ namespace Sentry.Unity.Tests;
 
 public class SentryUnitySelfInitializationTests
 {
+    private const string TestDsn = "https://[email protected]/4504604988538880";
+
     [TearDown]
     public void TearDown()
     {
@@ -67,7 +69,7 @@ public void SentryUnity_OptionsValid_Initializes()
     {
         var options = new SentryUnityOptions
         {
-            Dsn = "https://[email protected]/4504604988538880"
+            Dsn = TestDsn
         };
 
         SentryUnity.Init(options);
@@ -93,7 +95,7 @@ public void Init_MultipleTimes_LogsWarning()
         var options = new SentryUnityOptions
         {
             Debug = true,
-            Dsn = "https://[email protected]/4504604988538880",
+            Dsn = TestDsn,
             DiagnosticLogger = testLogger,
         };
 
@@ -104,4 +106,71 @@ public void Init_MultipleTimes_LogsWarning()
             log.logLevel == SentryLevel.Warning &&
             log.message.Contains("The SDK has already been initialized.")));
     }
+
+    [Test]
+    public void GetLastRunState_WithoutInit_ReturnsUnknown()
+    {
+        // Make sure SDK is closed
+        SentryUnity.Close();
+
+        // Act
+        var result = SentryUnity.GetLastRunState();
+
+        // Assert
+        Assert.AreEqual(SentryUnity.CrashedLastRun.Unknown, result);
+    }
+
+    [Test]
+    public void GetLastRunState_WhenCrashed_ReturnsCrashed()
+    {
+        // Arrange
+        var options = new SentryUnityOptions
+        {
+            Dsn = TestDsn,
+            CrashedLastRun = () => true // Mock crashed state
+        };
+
+        // Act
+        SentryUnity.Init(options);
+        var result = SentryUnity.GetLastRunState();
+
+        // Assert
+        Assert.AreEqual(SentryUnity.CrashedLastRun.Crashed, result);
+    }
+
+    [Test]
+    public void GetLastRunState_WhenNotCrashed_ReturnsDidNotCrash()
+    {
+        // Arrange
+        var options = new SentryUnityOptions
+        {
+            Dsn = TestDsn,
+            CrashedLastRun = () => false // Mock non-crashed state
+        };
+
+        // Act
+        SentryUnity.Init(options);
+        var result = SentryUnity.GetLastRunState();
+
+        // Assert
+        Assert.AreEqual(SentryUnity.CrashedLastRun.DidNotCrash, result);
+    }
+
+    [Test]
+    public void GetLastRunState_WithNullDelegate_ReturnsUnknown()
+    {
+        // Arrange
+        var options = new SentryUnityOptions
+        {
+            Dsn = TestDsn,
+            CrashedLastRun = null // Explicitly set to null
+        };
+
+        // Act
+        SentryUnity.Init(options);
+        var result = SentryUnity.GetLastRunState();
+
+        // Assert
+        Assert.AreEqual(SentryUnity.CrashedLastRun.Unknown, result);
+    }
 }