fix: User ID fallback on mobile (#1710)

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- Added a fallback for user.id on Android and iOS in case none could be extracted from the native layer ([#1710](https://github.com/getsentry/sentry-unity/pull/1710))
 - The IL2CPP exception processor no longer fails when the native support has been disabled ([#1708](https://github.com/getsentry/sentry-unity/pull/1708))
 
 ### Dependencies

src/Sentry.Unity.Android/AndroidJavaScopeObserver.cs

@@ -6,11 +6,11 @@ namespace Sentry.Unity.Android
     /// Scope Observer for Android through Java (JNI).
     /// </summary>
     /// <see href="https://github.com/getsentry/sentry-java"/>
-    public class AndroidJavaScopeObserver : ScopeObserver
+    internal class AndroidJavaScopeObserver : ScopeObserver
     {
-        private readonly JniExecutor _jniExecutor;
+        private readonly IJniExecutor _jniExecutor;
 
-        public AndroidJavaScopeObserver(SentryOptions options, JniExecutor jniExecutor) : base("Android", options)
+        public AndroidJavaScopeObserver(SentryOptions options, IJniExecutor jniExecutor) : base("Android", options)
         {
             _jniExecutor = jniExecutor;
         }

src/Sentry.Unity.Android/IJniExecutor.cs

@@ -0,0 +1,10 @@
+using System;
+
+namespace Sentry.Unity.Android
+{
+    internal interface IJniExecutor : IDisposable
+    {
+        public TResult? Run<TResult>(Func<TResult?> jniOperation);
+        public void Run(Action jniOperation);
+    }
+}

src/Sentry.Unity.Android/JniExecutor.cs

@@ -5,7 +5,7 @@
 
 namespace Sentry.Unity.Android
 {
-    public class JniExecutor
+    internal class JniExecutor : IJniExecutor
     {
         private readonly CancellationTokenSource _shutdownSource;
         private readonly AutoResetEvent _taskEvent;

src/Sentry.Unity.Android/NativeContextWriter.cs

@@ -4,11 +4,13 @@ namespace Sentry.Unity.Android
 {
     internal class NativeContextWriter : ContextWriter
     {
-        private readonly JniExecutor _jniExecutor;
+        private readonly IJniExecutor _jniExecutor;
+        private readonly ISentryJava _sentryJava;
 
-        public NativeContextWriter(JniExecutor jniExecutor)
+        public NativeContextWriter(IJniExecutor jniExecutor, ISentryJava sentryJava)
         {
             _jniExecutor = jniExecutor;
+            _sentryJava = sentryJava;
         }
 
         protected override void WriteScope(
@@ -50,7 +52,7 @@ protected override void WriteScope(
             // We're only setting the missing contexts, the rest is configured by sentry-java.  We could also sync
             // the "unity" context, but it doesn't seem so useful and the effort to do is larger because there's no
             // class for it in Java - not sure how we could add a generic context object in Java...
-            SentryJava.WriteScope(
+            _sentryJava.WriteScope(
                 _jniExecutor,
                 GpuId,
                 GpuName,

src/Sentry.Unity.Android/SentryJava.cs

@@ -4,6 +4,30 @@
 
 namespace Sentry.Unity.Android
 {
+    internal interface ISentryJava
+    {
+        public string? GetInstallationId(IJniExecutor jniExecutor);
+        public bool? CrashedLastRun(IJniExecutor jniExecutor);
+        public void Close(IJniExecutor jniExecutor);
+        public void WriteScope(
+            IJniExecutor jniExecutor,
+            int? GpuId,
+            string? GpuName,
+            string? GpuVendorName,
+            int? GpuMemorySize,
+            string? GpuNpotSupport,
+            string? GpuVersion,
+            string? GpuApiType,
+            int? GpuMaxTextureSize,
+            bool? GpuSupportsDrawCallInstancing,
+            bool? GpuSupportsRayTracing,
+            bool? GpuSupportsComputeShaders,
+            bool? GpuSupportsGeometryShaders,
+            string? GpuVendorId,
+            bool? GpuMultiThreadedRendering,
+            string? GpuGraphicsShaderLevel);
+    }
+
     /// <summary>
     /// JNI access to `sentry-java` methods.
     /// </summary>
@@ -12,9 +36,9 @@ namespace Sentry.Unity.Android
     /// and `sentry-java` maven packages.
     /// </remarks>
     /// <see href="https://github.com/getsentry/sentry-java"/>
-    internal static class SentryJava
+    internal class SentryJava : ISentryJava
     {
-        internal static string? GetInstallationId(JniExecutor jniExecutor)
+        public string? GetInstallationId(IJniExecutor jniExecutor)
         {
             return jniExecutor.Run(() =>
             {
@@ -35,7 +59,7 @@ internal static class SentryJava
         /// True if the last run terminated in a crash. No otherwise.
         /// If the SDK wasn't able to find this information, null is returned.
         /// </returns>
-        public static bool? CrashedLastRun(JniExecutor jniExecutor)
+        public bool? CrashedLastRun(IJniExecutor jniExecutor)
         {
             return jniExecutor.Run(() =>
             {
@@ -45,7 +69,7 @@ internal static class SentryJava
             });
         }
 
-        public static void Close(JniExecutor jniExecutor)
+        public void Close(IJniExecutor jniExecutor)
         {
             jniExecutor.Run(() =>
             {
@@ -56,8 +80,8 @@ public static void Close(JniExecutor jniExecutor)
 
         private static AndroidJavaObject GetSentryJava() => new AndroidJavaClass("io.sentry.Sentry");
 
-        public static void WriteScope(
-            JniExecutor jniExecutor,
+        public void WriteScope(
+            IJniExecutor jniExecutor,
             int? GpuId,
             string? GpuName,
             string? GpuVendorName,
@@ -101,28 +125,6 @@ public static void WriteScope(
             });
         }
 
-        private static void SetIfNotNull<T>(this AndroidJavaObject javaObject, string property, T? value, string? valueClass = null)
-        {
-            if (value is not null)
-            {
-                if (valueClass is null)
-                {
-                    javaObject.Set(property, value!);
-                }
-                else
-                {
-                    using var valueObject = new AndroidJavaObject(valueClass, value!);
-                    javaObject.Set(property, valueObject);
-                }
-            }
-        }
-
-        private static void SetIfNotNull(this AndroidJavaObject javaObject, string property, int? value) =>
-            SetIfNotNull(javaObject, property, value, "java.lang.Integer");
-
-        private static void SetIfNotNull(this AndroidJavaObject javaObject, string property, bool? value) =>
-            SetIfNotNull(javaObject, property, value, "java.lang.Boolean");
-
         // Implements the io.sentry.ScopeCallback interface.
         internal class ScopeCallback : AndroidJavaProxy
         {
@@ -156,4 +158,29 @@ public ScopeCallback(Action<AndroidJavaObject> callback) : base("io.sentry.Scope
             }
         }
     }
+
+    internal static class AndroidJavaObjectExtension
+    {
+        public static void SetIfNotNull<T>(this AndroidJavaObject javaObject, string property, T? value, string? valueClass = null)
+        {
+            if (value is not null)
+            {
+                if (valueClass is null)
+                {
+                    javaObject.Set(property, value!);
+                }
+                else
+                {
+                    using var valueObject = new AndroidJavaObject(valueClass, value!);
+                    javaObject.Set(property, valueObject);
+                }
+            }
+        }
+
+        public static void SetIfNotNull(this AndroidJavaObject javaObject, string property, int? value) =>
+            SetIfNotNull(javaObject, property, value, "java.lang.Integer");
+
+        public static void SetIfNotNull(this AndroidJavaObject javaObject, string property, bool? value) =>
+            SetIfNotNull(javaObject, property, value, "java.lang.Boolean");
+    }
 }

src/Sentry.Unity.Android/SentryNativeAndroid.cs

@@ -1,6 +1,7 @@
 using System;
 using Sentry.Extensibility;
 using UnityEngine;
+using UnityEngine.Analytics;
 
 namespace Sentry.Unity.Android
 {
@@ -9,7 +10,8 @@ namespace Sentry.Unity.Android
     /// </summary>
     public static class SentryNativeAndroid
     {
-        private static JniExecutor? JniExecutor;
+        internal static IJniExecutor? JniExecutor;
+        internal static ISentryJava? SentryJava;
 
         /// <summary>
         /// Configures the native Android support.
@@ -25,9 +27,10 @@ public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentry
                 return;
             }
 
-            JniExecutor = new JniExecutor();
+            JniExecutor ??= new JniExecutor();
+            SentryJava ??= new SentryJava();
 
-            options.NativeContextWriter = new NativeContextWriter(JniExecutor);
+            options.NativeContextWriter = new NativeContextWriter(JniExecutor, SentryJava);
             options.ScopeObserver = new AndroidJavaScopeObserver(options, JniExecutor);
             options.EnableScopeSync = true;
             options.CrashedLastRun = () =>
@@ -64,7 +67,26 @@ public static void Configure(SentryUnityOptions options, ISentryUnityInfo sentry
             }
 
             options.NativeSupportCloseCallback = () => Close(options.DiagnosticLogger);
+
             options.DefaultUserId = SentryJava.GetInstallationId(JniExecutor);
+            if (string.IsNullOrEmpty(options.DefaultUserId))
+            {
+                // In case we can't get an installation ID we create one and sync that down to the native layer
+                options.DiagnosticLogger?.LogDebug("Failed to fetch 'Installation ID' from the native SDK. Creating new 'Default User ID'.");
+
+                // We fall back to Unity's Analytics Session Info: https://docs.unity3d.com/ScriptReference/Analytics.AnalyticsSessionInfo-userId.html
+                // It's a randomly generated GUID that gets created immediately after installation helping
+                // to identify the same instance of the game
+                options.DefaultUserId = AnalyticsSessionInfo.userId;
+                if (options.DefaultUserId is not null)
+                {
+                    options.ScopeObserver.SetUser(new SentryUser { Id = options.DefaultUserId });
+                }
+                else
+                {
+                    options.DiagnosticLogger?.LogDebug("Failed to create new 'Default User ID'.");
+                }
+            }
         }
 
         /// <summary>
@@ -78,7 +100,7 @@ public static void Close(IDiagnosticLogger? logger = null)
             // This is an edge-case where the Android SDK has been enabled and setup during build-time but is being
             // shut down at runtime. In this case Configure() has not been called and there is no JniExecutor yet
             JniExecutor ??= new JniExecutor();
-            SentryJava.Close(JniExecutor);
+            SentryJava?.Close(JniExecutor);
             JniExecutor.Dispose();
         }
     }

src/Sentry.Unity.iOS/SentryNativeCocoa.cs

@@ -3,6 +3,7 @@
 using Sentry.PlatformAbstractions;
 using Sentry.Unity.Integrations;
 using UnityEngine;
+using UnityEngine.Analytics;
 
 namespace Sentry.Unity.iOS
 {
@@ -58,6 +59,24 @@ internal static void Configure(SentryUnityOptions options, ISentryUnityInfo sent
             if (sentryUnityInfo.IL2CPP)
             {
                 options.DefaultUserId = SentryCocoaBridgeProxy.GetInstallationId();
+                if (string.IsNullOrEmpty(options.DefaultUserId))
+                {
+                    // In case we can't get an installation ID we create one and sync that down to the native layer
+                    options.DiagnosticLogger?.LogDebug("Failed to fetch 'Installation ID' from the native SDK. Creating new 'Default User ID'.");
+
+                    // We fall back to Unity's Analytics Session Info: https://docs.unity3d.com/ScriptReference/Analytics.AnalyticsSessionInfo-userId.html
+                    // It's a randomly generated GUID that gets created immediately after installation helping
+                    // to identify the same instance of the game
+                    options.DefaultUserId = AnalyticsSessionInfo.userId;
+                    if (options.DefaultUserId is not null)
+                    {
+                        options.ScopeObserver.SetUser(new SentryUser { Id = options.DefaultUserId });
+                    }
+                    else
+                    {
+                        options.DiagnosticLogger?.LogDebug("Failed to create new 'Default User ID'.");
+                    }
+                }
             }
         }
 

test/Sentry.Unity.Android.Tests/SentryNativeAndroidTests.cs

@@ -1,8 +1,6 @@
 using System;
 using System.Threading;
 using NUnit.Framework;
-using Sentry.Unity;
-using UnityEngine;
 
 namespace Sentry.Unity.Android.Tests
 {
@@ -24,6 +22,9 @@ public void SetUp()
                     _fakeReinstallSentryNativeBackendStrategy);
             _reinstallCalled = false;
             _sentryUnityInfo = new TestUnityInfo { IL2CPP = false };
+
+            SentryNativeAndroid.JniExecutor = new TestJniExecutor();
+            SentryNativeAndroid.SentryJava = new TestSentryJava();
         }
 
         [TearDown]
@@ -92,5 +93,17 @@ public void Configure_NativeAndroidSupportDisabled_DoesNotReInitializeNativeBack
             SentryNativeAndroid.Configure(options, _sentryUnityInfo);
             Assert.False(_reinstallCalled);
         }
+
+        [Test]
+        public void Configure_NoInstallationIdReturned_SetsNewDefaultUserId()
+        {
+            var options = new SentryUnityOptions();
+            var sentryJava = SentryNativeAndroid.SentryJava as TestSentryJava;
+            Assert.NotNull(sentryJava);
+            sentryJava!.InstallationId = string.Empty;
+
+            SentryNativeAndroid.Configure(options, _sentryUnityInfo);
+            Assert.False(string.IsNullOrEmpty(options.DefaultUserId));
+        }
     }
 }

test/Sentry.Unity.Android.Tests/TestJniExecutor.cs

@@ -0,0 +1,21 @@
+using System;
+
+namespace Sentry.Unity.Android.Tests
+{
+    public class TestJniExecutor : IJniExecutor
+    {
+        public TResult? Run<TResult>(Func<TResult?> jniOperation)
+        {
+            return default;
+        }
+
+        public void Run(Action jniOperation)
+        {
+        }
+
+        public void Dispose()
+        {
+            // TODO release managed resources here
+        }
+    }
+}

test/Sentry.Unity.Android.Tests/TestSentryJava.cs

@@ -0,0 +1,39 @@
+namespace Sentry.Unity.Android.Tests
+{
+    internal class TestSentryJava : ISentryJava
+    {
+        public string? InstallationId { get; set; }
+        public bool? IsCrashedLastRun { get; set; }
+
+        public string? GetInstallationId(IJniExecutor jniExecutor)
+        {
+            return InstallationId;
+        }
+
+        public bool? CrashedLastRun(IJniExecutor jniExecutor)
+        {
+            return IsCrashedLastRun;
+        }
+
+        public void Close(IJniExecutor jniExecutor) { }
+
+        public void WriteScope(
+            IJniExecutor jniExecutor,
+            int? GpuId,
+            string? GpuName,
+            string? GpuVendorName,
+            int? GpuMemorySize,
+            string? GpuNpotSupport,
+            string? GpuVersion,
+            string? GpuApiType,
+            int? GpuMaxTextureSize,
+            bool? GpuSupportsDrawCallInstancing,
+            bool? GpuSupportsRayTracing,
+            bool? GpuSupportsComputeShaders,
+            bool? GpuSupportsGeometryShaders,
+            string? GpuVendorId,
+            bool? GpuMultiThreadedRendering,
+            string? GpuGraphicsShaderLevel)
+        { }
+    }
+}