Close sentry instance when quitting the app

CHANGELOG.md

@@ -9,6 +9,7 @@
 ### Fixes
 
 - iOS builds no longer break when native support disabled or not available ([#592](https://github.com/getsentry/sentry-unity/pull/592))
+- Close sentry instance when quitting the app ([#608](https://github.com/getsentry/sentry-unity/pull/608))
 
 ## 0.11.0
 

package-dev/Plugins/iOS/SentryNativeBridge.m

@@ -6,6 +6,10 @@ bool CrashedLastRun() {
     return[SentrySDK crashedLastRun];
 }
 
+void Close() {
+    [SentrySDK close];
+}
+
 void SentryNativeBridgeAddBreadcrumb(const char* timestamp, const char* message, const char* type, const char* category, int level) {
     if (timestamp == NULL && message == NULL && type == NULL && category == NULL) {
         return;

src/Sentry.Unity.Android/SentryJava.cs

@@ -28,5 +28,11 @@ public static class SentryJava
             return jo.CallStatic<AndroidJavaObject>("isCrashedLastRun")
                 ?.Call<bool>("booleanValue");
         }
+
+        public static void Close()
+        {
+            using var jo = new AndroidJavaObject("io.sentry.Sentry");
+            jo.CallStatic<AndroidJavaObject>("close");
+        }
     }
 }

src/Sentry.Unity.Android/SentryNative.cs

@@ -14,6 +14,8 @@ namespace Sentry.Unity.Android
     /// <see href="https://github.com/getsentry/sentry-native"/>
     public static class SentryNative
     {
+        public static void Close() => sentry_close();
+
         /// <summary>
         /// Re-installs the sentry-native backend essentially retaking the signal handlers.
         /// </summary>
@@ -30,6 +32,9 @@ public static class SentryNative
         [DllImport("sentry")]
         private static extern void sentry_reinstall_backend();
 
+        [DllImport("sentry")]
+        private static extern void sentry_close();
+
         // Testing
         internal static Action ReinstallSentryNativeBackendStrategy = sentry_reinstall_backend;
     }

src/Sentry.Unity.Android/SentryNativeAndroid.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Unity.Integrations;
 
 namespace Sentry.Unity.Android
 {
@@ -44,6 +45,13 @@ public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentry
                     // So we register our backend once more to make sure user-defined data is available in the crash report.
                     SentryNative.ReinstallBackend();
                 }
+                ApplicationAdapter.Instance.Quitting += () =>
+                {
+                    options.DiagnosticLogger?.LogDebug("Closing the sentry-java SDK");
+                    SentryJava.Close();
+                    options.DiagnosticLogger?.LogDebug("Closing the sentry-native SDK");
+                    SentryNative.Close();
+                };
             }
         }
     }

src/Sentry.Unity.Native/SentryNative.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Unity.Integrations;
 
 namespace Sentry.Unity.Native
 {
@@ -16,6 +17,11 @@ public static void Configure(SentryUnityOptions options)
             if (options.WindowsNativeSupportEnabled)
             {
                 SentryNativeBridge.Init(options);
+                ApplicationAdapter.Instance.Quitting += () =>
+                {
+                    options.DiagnosticLogger?.LogDebug("Closing the sentry-native SDK");
+                    SentryNativeBridge.Close();
+                };
                 options.ScopeObserver = new NativeScopeObserver(options);
                 options.EnableScopeSync = true;
                 // options.CrashedLastRun = () =>

src/Sentry.Unity.Native/SentryNativeBridge.cs

@@ -82,6 +82,8 @@ public static void Init(SentryUnityOptions options)
             sentry_init(cOptions);
         }
 
+        public static void Close() => sentry_close();
+
         // libsentry.so
         [DllImport("sentry")]
         private static extern IntPtr sentry_options_new();
@@ -167,6 +169,9 @@ private static void nativeLog(int cLevel, string message, IntPtr args, IntPtr us
         [DllImport("sentry")]
         private static extern void sentry_init(IntPtr options);
 
+        [DllImport("sentry")]
+        private static extern int sentry_close();
+
         /// <summary>
         /// Re-installs the sentry-native backend essentially retaking the signal handlers.
         /// </summary>

src/Sentry.Unity.iOS/SentryCocoaBridgeProxy.cs

@@ -14,6 +14,9 @@ internal static class SentryCocoaBridgeProxy
         [DllImport("__Internal")]
         public static extern bool CrashedLastRun();
 
+        [DllImport("__Internal")]
+        public static extern void Close();
+
         [DllImport("__Internal")]
         public static extern void SentryNativeBridgeAddBreadcrumb(string timestamp, string? message, string? type, string? category, int level);
 

src/Sentry.Unity.iOS/SentryNativeIos.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Unity.Integrations;
 
 namespace Sentry.Unity.iOS
 {
@@ -25,6 +26,11 @@ public static void Configure(SentryUnityOptions options)
 
                     return crashedLastRun;
                 };
+                ApplicationAdapter.Instance.Quitting += () =>
+                {
+                    options.DiagnosticLogger?.LogDebug("Closing the sentry-cocoa SDK");
+                    SentryCocoaBridgeProxy.Close();
+                };
             }
         }
     }

src/Sentry.Unity/Integrations/IApplication.cs

@@ -16,7 +16,8 @@ internal interface IApplication
         RuntimePlatform Platform { get; }
     }
 
-    internal sealed class ApplicationAdapter : IApplication
+    /// Semi-internal class to be used by other Sentry.Unity assemblies
+    public sealed class ApplicationAdapter : IApplication
     {
         public static readonly ApplicationAdapter Instance = new();
 

src/Sentry.Unity/SentryUnity.cs

@@ -1,6 +1,7 @@
 using System;
 using System.ComponentModel;
 using Sentry.Extensibility;
+using Sentry.Unity.Integrations;
 
 namespace Sentry.Unity
 {
@@ -31,7 +32,12 @@ public static void Init(SentryUnityOptions sentryUnityOptions)
             if (sentryUnityOptions.ShouldInitializeSdk())
             {
                 sentryUnityOptions.DiagnosticLogger?.LogDebug(sentryUnityOptions.ToString());
-                SentrySdk.Init(sentryUnityOptions);
+                var sentryDotNet = SentrySdk.Init(sentryUnityOptions);
+                ApplicationAdapter.Instance.Quitting += () =>
+                {
+                    sentryUnityOptions.DiagnosticLogger?.LogDebug("Closing the sentry-dotnet SDK");
+                    sentryDotNet.Dispose();
+                };
             }
         }
     }