Merge branch 'main' into fix-linux-musl-arm64

Author: jpnurmi

CHANGELOG.md

@@ -2,10 +2,16 @@
 
 ## Unreleased
 
+### Features
+
+- Sentry now includes an EXPERIMENTAL StringStackTraceFactory. This factory isn't as feature rich as the full `SentryStackTraceFactory`. However, it may provide better results if you are compiling your application AOT and not getting useful stack traces from the full stack trace factory. ([#4362](https://github.com/getsentry/sentry-dotnet/pull/4362))
+
 ### Fixes
 
+- Source context for class libraries when running on Android in Release mode ([#4294](https://github.com/getsentry/sentry-dotnet/pull/4294))
 - Native AOT: don't load SentryNative on unsupported platforms ([#4347](https://github.com/getsentry/sentry-dotnet/pull/4347))
 - Fixed issue introduced in release 5.12.0 that might prevent other middleware or user code from reading request bodies ([#4373](https://github.com/getsentry/sentry-dotnet/pull/4373))
+- SentryTunnelMiddleware overwrites the X-Forwarded-For header ([#4375](https://github.com/getsentry/sentry-dotnet/pull/4375))
 - Native AOT support for `linux-musl-arm64` ([#4365](https://github.com/getsentry/sentry-dotnet/pull/4365))
 
 ### Dependencies

src/Sentry.Android.AssemblyReader/V2/AndroidAssemblyStoreReaderV2.cs

@@ -100,11 +100,19 @@ public static bool TryReadStore(string inputFile, IList<string> supportedAbis, D
             return assembly;
         }
 
+        // If the assembly name ends with .dll or .exe, try to find it without the extension.
         if ((IsFileType(".dll") || IsFileType(".exe")) && FindBestAssembly(name[..^4], out assembly))
         {
             return assembly;
         }
 
+        // Conversely, if there is no extension, try with the dll extension (sometimes required for class libraries).
+        // See: https://github.com/getsentry/sentry-dotnet/issues/4278#issuecomment-2986009125
+        if (!IsFileType(".dll") && !IsFileType(".exe") && FindBestAssembly(name + ".dll", out assembly))
+        {
+            return assembly;
+        }
+
         return null;
 
         bool IsFileType(string extension)
@@ -119,10 +127,12 @@ private bool FindBestAssembly(string name, out ExplorerStoreItem? explorerAssemb
         {
             if (explorer.AssembliesByName?.TryGetValue(name, out var assembly) is true)
             {
+                _logger?.Invoke("Found best assembly {0} in APK AssemblyStore for target arch {1}", name, explorer.TargetArch);
                 explorerAssembly = new(explorer, assembly);
                 return true;
             }
         }
+        _logger?.Invoke("No best assembly for {0} in APK AssemblyStore", name);
         explorerAssembly = null;
         return false;
     }

src/Sentry.Android.AssemblyReader/V2/AssemblyStoreExplorer.cs

@@ -33,6 +33,7 @@ private AssemblyStoreExplorer(Stream storeStream, string path, DebugLogger? logg
         {
             foreach (var item in Assemblies)
             {
+                logger?.Invoke("Assembly {0} indexed from AssemblyStore {1}", item.Name, path);
                 dict.Add(item.Name, item);
             }
         }

src/Sentry.AspNetCore/SentryTunnelMiddleware.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Primitives;
 using Sentry.Internal.Extensions;
 
 namespace Sentry.AspNetCore;
@@ -98,10 +99,9 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
                     Method = HttpMethod.Post,
                     Content = new StreamContent(memoryStream),
                 };
-                var clientIp = context.Connection?.RemoteIpAddress?.ToString();
-                if (clientIp != null)
+                if (CreateXForwardedForHeader(context) is { } forwardedFor)
                 {
-                    sentryRequest.Headers.Add("X-Forwarded-For", context.Connection?.RemoteIpAddress?.ToString());
+                    sentryRequest.Headers.Add("X-Forwarded-For", forwardedFor);
                 }
                 var responseMessage = await client.SendAsync(sentryRequest).ConfigureAwait(false);
                 // We send the response back to the client, whatever it was
@@ -122,6 +122,25 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
         }
     }
 
+    private static string? CreateXForwardedForHeader(HttpContext context)
+    {
+        var existingForwardedFor = context.Request.Headers["X-Forwarded-For"];
+        var clientIp = context.Connection?.RemoteIpAddress?.ToString();
+        if (clientIp is null)
+        {
+            return existingForwardedFor.Count > 0 ? existingForwardedFor.ToString() : null;
+        }
+
+        if (existingForwardedFor.Count == 0)
+        {
+            return clientIp;
+        }
+
+        return string.IsNullOrEmpty(existingForwardedFor)
+            ? clientIp
+            : $"{existingForwardedFor}, {clientIp}";
+    }
+
     private bool IsHostAllowed(string host) =>
         host.EndsWith(".sentry.io", StringComparison.OrdinalIgnoreCase) ||
         host.Equals("sentry.io", StringComparison.OrdinalIgnoreCase) ||

src/Sentry.Maui.CommunityToolkit.Mvvm/SentryOptionsExtensions.cs

@@ -12,7 +12,7 @@ public static class SentryOptionsExtensions
     /// </summary>
     public static SentryMauiOptions AddCommunityToolkitIntegration(this SentryMauiOptions options)
     {
-        options.AddDefaultEventBinder<MauiCommunityToolkitMvvmEventsBinder>();
+        options.AddIntegrationEventBinder<MauiCommunityToolkitMvvmEventsBinder>();
         return options;
     }
 }

src/Sentry.Maui/Internal/MauiButtonEventsBinder.cs

@@ -21,6 +21,7 @@ public void Bind(VisualElement element, Action<BreadcrumbEvent> addBreadcrumb)
     /// <inheritdoc />
     public void UnBind(VisualElement element)
     {
+        _addBreadcrumbCallback = null;
         if (element is Button button)
         {
             button.Clicked -= OnButtonOnClicked;

src/Sentry.Maui/Internal/MauiImageButtonEventsBinder.cs

@@ -3,12 +3,12 @@ namespace Sentry.Maui.Internal;
 /// <inheritdoc />
 public class MauiImageButtonEventsBinder : IMauiElementEventBinder
 {
-    private Action<BreadcrumbEvent>? addBreadcrumbCallback;
+    private Action<BreadcrumbEvent>? _addBreadcrumbCallback;
 
     /// <inheritdoc />
     public void Bind(VisualElement element, Action<BreadcrumbEvent> addBreadcrumb)
     {
-        addBreadcrumbCallback = addBreadcrumb;
+        _addBreadcrumbCallback = addBreadcrumb;
 
         if (element is ImageButton image)
         {
@@ -21,6 +21,7 @@ public void Bind(VisualElement element, Action<BreadcrumbEvent> addBreadcrumb)
     /// <inheritdoc />
     public void UnBind(VisualElement element)
     {
+        _addBreadcrumbCallback = null;
         if (element is ImageButton image)
         {
             image.Clicked -= OnButtonOnClicked;
@@ -31,11 +32,11 @@ public void UnBind(VisualElement element)
 
 
     private void OnButtonOnClicked(object? sender, EventArgs _)
-        => addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Clicked)));
+        => _addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Clicked)));
 
     private void OnButtonOnPressed(object? sender, EventArgs _)
-        => addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Pressed)));
+        => _addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Pressed)));
 
     private void OnButtonOnReleased(object? sender, EventArgs _)
-        => addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Released)));
+        => _addBreadcrumbCallback?.Invoke(new(sender, nameof(ImageButton.Released)));
 }

src/Sentry.Maui/SentryMauiAppBuilderExtensions.cs

@@ -56,10 +56,16 @@ public static MauiAppBuilder UseSentry(this MauiAppBuilder builder,
         services.AddSingleton<IConfigureOptions<SentryMauiOptions>, SentryMauiOptionsSetup>();
         services.AddSingleton<Disposer>();
 
-        // Resolve the configured options and register any element event binders from these
+        // Add default event binders
+        services.AddSingleton<IMauiElementEventBinder, MauiButtonEventsBinder>();
+        services.AddSingleton<IMauiElementEventBinder, MauiImageButtonEventsBinder>();
+        services.AddSingleton<IMauiElementEventBinder, MauiGestureRecognizerEventsBinder>();
+        services.AddSingleton<IMauiElementEventBinder, MauiVisualElementEventsBinder>();
+
+        // Resolve the configured options and register any event binders that have been injected by integrations
         var options = new SentryMauiOptions();
         configureOptions?.Invoke(options);
-        foreach (var eventBinder in options.DefaultEventBinders)
+        foreach (var eventBinder in options.IntegrationEventBinders)
         {
             eventBinder.Register(services);
         }

src/Sentry.Maui/SentryMauiOptions.cs

@@ -23,18 +23,14 @@ public SentryMauiOptions()
 #if !PLATFORM_NEUTRAL
         CacheDirectoryPath = Microsoft.Maui.Storage.FileSystem.CacheDirectory;
 #endif
-        AddDefaultEventBinder<MauiButtonEventsBinder>();
-        AddDefaultEventBinder<MauiImageButtonEventsBinder>();
-        AddDefaultEventBinder<MauiGestureRecognizerEventsBinder>();
-        AddDefaultEventBinder<MauiVisualElementEventsBinder>();
     }
 
-    internal List<IMauiElementEventBinderRegistration> DefaultEventBinders { get; } = [];
+    internal List<IMauiElementEventBinderRegistration> IntegrationEventBinders { get; } = [];
 
-    internal void AddDefaultEventBinder<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TEventBinder>()
+    internal void AddIntegrationEventBinder<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TEventBinder>()
         where TEventBinder : class, IMauiElementEventBinder
     {
-        DefaultEventBinders.Add(new MauiElementEventBinderRegistration<TEventBinder>());
+        IntegrationEventBinders.Add(new MauiElementEventBinderRegistration<TEventBinder>());
     }
 
     /// <summary>

src/Sentry/Extensibility/ISentryStackTraceFactory.cs

@@ -1,7 +1,7 @@
 namespace Sentry.Extensibility;
 
 /// <summary>
-/// Factory to <see cref="SentryStackTrace" /> from an <see cref="Exception" />.
+/// Factory to create a <see cref="SentryStackTrace" /> from an <see cref="Exception" />.
 /// </summary>
 public interface ISentryStackTraceFactory
 {