Workaround thread safety issues accessing Android device data

Author: jamescrosswell

Directory.Build.props

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <VersionPrefix>5.0.0-alpha.1</VersionPrefix>
-    <LangVersion>12</LangVersion>
+    <LangVersion>13</LangVersion>
     <AccelerateBuildsInVisualStudio>true</AccelerateBuildsInVisualStudio>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory).assets\Sentry.snk</AssemblyOriginatorKeyFile>

src/Sentry.Maui/Internal/MauiDeviceData.cs

@@ -6,7 +6,28 @@ namespace Sentry.Maui.Internal;
 
 internal static class MauiDeviceData
 {
-    public static void ApplyMauiDeviceData(this Device device, IDiagnosticLogger? logger)
+#if NET9_0_OR_GREATER && ANDROID
+    private static readonly Lock JniLock = new();
+#elif ANDROID
+    private static readonly object JniLock = new();
+#endif
+
+    public static void ApplyMauiDeviceData(this Device device, IDiagnosticLogger? logger,
+        INetworkStatusListener? networkStatusListener)
+    {
+#if ANDROID
+        // Accessing device information on Android doesn't have to happen on the UI thread, but it's not threadsafe.
+        // See: https://github.com/getsentry/sentry-dotnet/issues/3627
+        lock (JniLock)
+        {
+            ApplyMauiDeviceDataInternal(device, logger, networkStatusListener);
+        }
+#else
+        ApplyMauiDeviceDataInternal(device, logger, networkStatusListener);
+#endif
+    }
+
+    private static void ApplyMauiDeviceDataInternal(Device device, IDiagnosticLogger? logger, INetworkStatusListener? networkStatusListener)
     {
         try
         {
@@ -54,10 +75,9 @@ public static void ApplyMauiDeviceData(this Device device, IDiagnosticLogger? lo
                 logger?.LogDebug("No permission to read battery state from the device.");
             }
 
-            // https://docs.microsoft.com/dotnet/maui/platform-integration/communication/networking#using-connectivity
             try
             {
-                device.IsOnline ??= Connectivity.NetworkAccess == NetworkAccess.Internet;
+                device.IsOnline ??= networkStatusListener?.Online;
             }
             catch (PermissionException)
             {

src/Sentry.Maui/Internal/SentryMauiEventProcessor.cs

@@ -17,7 +17,7 @@ public SentryEvent Process(SentryEvent @event)
     {
         @event.Sdk.Name = Constants.SdkName;
         @event.Sdk.Version = Constants.SdkVersion;
-        @event.Contexts.Device.ApplyMauiDeviceData(_options.DiagnosticLogger);
+        @event.Contexts.Device.ApplyMauiDeviceData(_options.DiagnosticLogger, _options.NetworkStatusListener);
         @event.Contexts.OperatingSystem.ApplyMauiOsData(_options.DiagnosticLogger);
         @event.Contexts.App.InForeground = InForeground;
 

src/Sentry/Internal/Http/CachingTransport.cs

@@ -41,7 +41,7 @@ internal class CachingTransport : ITransport, IDisposable
     // and write from/to the cache directory.
     // Lock usage is minimized by moving files that are being processed to a special directory
     // where collisions are not expected.
-    private readonly Lock _cacheDirectoryLock = new();
+    private readonly SentryLock _cacheDirectoryLock = new();
 
     private readonly CancellationTokenSource _workerCts = new();
     private Task _worker = null!;

src/Sentry/Internal/Lock.cs src/Sentry/Internal/SentryLock.cssrc/Sentry/Internal/Lock.cs renamed to src/Sentry/Internal/SentryLock.cs

@@ -1,10 +1,10 @@
 namespace Sentry.Internal;
 
-internal class Lock : IDisposable
+internal class SentryLock : IDisposable
 {
     private readonly Signal _signal;
 
-    public Lock() => _signal = new Signal(true);
+    public SentryLock() => _signal = new Signal(true);
 
     public async Task<IDisposable> AcquireAsync(CancellationToken cancellationToken = default)
     {