Merge branch 'main' into feat/4.0.0

Author: jamescrosswell

.github/actions/environment/action.yml

@@ -33,4 +33,5 @@ runs:
           maui-android \
           ${{ runner.os == 'macOS' && 'maui-ios maui-maccatalyst maui-windows' || '' }} \
           ${{ runner.os == 'Windows' && 'maui-windows' || '' }} \
-          --temp-dir "${{ runner.temp }}"
+          --temp-dir "${{ runner.temp }}" \
+          --skip-sign-check

CHANGELOG.md

@@ -165,6 +165,7 @@ There are some functional differences when publishing Native AOT:
 ### Fixes
 
 - `CaptureFailedRequests` and `FailedRequestStatusCodes` are now getting respected by the Cocoa SDK. This is relevant for MAUI apps where requests are getting handled natively. ([#2826](https://github.com/getsentry/sentry-dotnet/issues/2826))
+- Added `SentryOptions.AutoRegisterTracing` for users who need to control registration of Sentry's tracing middleware ([#2871](https://github.com/getsentry/sentry-dotnet/pull/2871))
 
 ### Dependencies
 
@@ -174,6 +175,9 @@ There are some functional differences when publishing Native AOT:
 - Bump CLI from v2.21.2 to v2.21.5 ([#2811](https://github.com/getsentry/sentry-dotnet/pull/2811), [#2834](https://github.com/getsentry/sentry-dotnet/pull/2834), [#2851](https://github.com/getsentry/sentry-dotnet/pull/2851))
   - [changelog](https://github.com/getsentry/sentry-cli/blob/master/CHANGELOG.md#2215)
   - [diff](https://github.com/getsentry/sentry-cli/compare/2.21.2...2.21.5)
+- Bump Java SDK from v6.33.1 to v6.34.0 ([#2874](https://github.com/getsentry/sentry-dotnet/pull/2874))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#6340)
+  - [diff](https://github.com/getsentry/sentry-java/compare/6.33.1...6.34.0)
 
 ## 3.41.0
 

src/Sentry.AspNetCore/SentryAspNetCoreOptions.cs

@@ -1,3 +1,4 @@
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
 using Sentry.Extensibility;
@@ -65,6 +66,21 @@ public class SentryAspNetCoreOptions : SentryLoggingOptions
     /// </remarks>
     public bool AdjustStandardEnvironmentNameCasing { get; set; } = true;
 
+    /// <summary>
+    /// <para>
+    /// When true (by default) Sentry automatically registers its tracing middleware immediately after
+    /// `EndpointRoutingApplicationBuilderExtensions.UseRouting`.
+    /// </para>
+    /// <para>
+    /// If you need to control when Sentry's tracing middleware is registered, you can set
+    /// <see cref="AutoRegisterTracing"/> to false and call
+    /// <see cref="SentryTracingMiddlewareExtensions.UseSentryTracing"/> yourself, sometime after calling
+    /// `EndpointRoutingApplicationBuilderExtensions.UseRouting` and before calling
+    /// `EndpointRoutingApplicationBuilderExtensions.UseEndpoints`.
+    /// </para>
+    /// </summary>
+    public bool AutoRegisterTracing { get; set; } = true;
+
     /// <summary>
     /// Creates a new instance of <see cref="SentryAspNetCoreOptions"/>.
     /// </summary>

src/Sentry.AspNetCore/SentryTracingBuilder.cs

@@ -49,12 +49,13 @@ public IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware
         {
             var options = InnerBuilder.ApplicationServices.GetService<IOptions<SentryAspNetCoreOptions>>();
             var instrumenter = options?.Value.Instrumenter ?? Instrumenter.Sentry;
-            if (instrumenter == Instrumenter.Sentry)
+            var autoRegisterTracing = options?.Value.AutoRegisterTracing ?? true;
+            if (instrumenter == Instrumenter.Sentry && autoRegisterTracing)
             {
-                InnerBuilder.Use(middleware).UseSentryTracing();
+                InnerBuilder.Use(middleware).UseSentryTracingInternal();
                 return this; // Make sure we return the same builder (not the inner builder), for chaining
             }
-            this.StoreInstrumenter(instrumenter); // Saves us from having to resolve the options to make this check again
+            this.StoreRegistrationDecision(false); // Saves us from having to resolve the options to make this check again
         }
 
         InnerBuilder.Use(middleware);

src/Sentry.AspNetCore/SentryTracingMiddlewareExtensions.cs

@@ -1,5 +1,8 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Sentry;
 using Sentry.AspNetCore;
+using Sentry.Extensibility;
 using Sentry.Internal.Extensions;
 
 // ReSharper disable once CheckNamespace
@@ -11,32 +14,30 @@ namespace Microsoft.AspNetCore.Builder;
 [EditorBrowsable(EditorBrowsableState.Never)]
 public static class SentryTracingMiddlewareExtensions
 {
+    internal const string AlreadyRegisteredWarning = "Sentry tracing middleware was already registered. This call to UseSentryTracing is unnecessary.";
     private const string UseSentryTracingKey = "__UseSentryTracing";
-    private const string InstrumenterKey = "__SentryInstrumenter";
+    private const string ShouldRegisterKey = "__ShouldRegisterSentryTracing";
 
     internal static bool IsSentryTracingRegistered(this IApplicationBuilder builder)
         => builder.Properties.ContainsKey(UseSentryTracingKey);
-    internal static void StoreInstrumenter(this IApplicationBuilder builder, Instrumenter instrumenter)
-        => builder.Properties[InstrumenterKey] = instrumenter;
+    internal static void StoreRegistrationDecision(this IApplicationBuilder builder, bool shouldRegisterSentryTracing)
+        => builder.Properties[ShouldRegisterKey] = shouldRegisterSentryTracing;
 
     internal static bool ShouldRegisterSentryTracing(this IApplicationBuilder builder)
     {
         if (builder.Properties.ContainsKey(UseSentryTracingKey))
         {
+            // It's already been registered
             return false;
         }
-        if (builder.Properties.TryGetTypedValue(InstrumenterKey, out Instrumenter instrumenter))
+        if (builder.Properties.TryGetTypedValue(ShouldRegisterKey, out bool shouldRegisterSentryTracing))
         {
-            return instrumenter == Instrumenter.Sentry;
+            return shouldRegisterSentryTracing;
         }
         return true;
     }
 
-    /// <summary>
-    /// Adds Sentry's tracing middleware to the pipeline.
-    /// Make sure to place this middleware after <c>UseRouting(...)</c>.
-    /// </summary>
-    public static IApplicationBuilder UseSentryTracing(this IApplicationBuilder builder)
+    internal static IApplicationBuilder UseSentryTracingInternal(this IApplicationBuilder builder)
     {
         // Don't register twice
         if (builder.IsSentryTracingRegistered())
@@ -48,4 +49,21 @@ public static IApplicationBuilder UseSentryTracing(this IApplicationBuilder buil
         builder.UseMiddleware<SentryTracingMiddleware>();
         return builder;
     }
+
+    /// <summary>
+    /// Adds Sentry's tracing middleware to the pipeline.
+    /// Make sure to place this middleware after <c>UseRouting(...)</c>.
+    /// </summary>
+    public static IApplicationBuilder UseSentryTracing(this IApplicationBuilder builder)
+    {
+        if (!builder.IsSentryTracingRegistered())
+        {
+            return builder.UseSentryTracingInternal();
+        }
+        // Warn on multiple calls
+        var log = builder.ApplicationServices.GetService<ILoggerFactory>()
+            ?.CreateLogger<SentryTracingMiddleware>();
+        log?.LogWarning(AlreadyRegisteredWarning);
+        return builder;
+    }
 }

src/Sentry.Bindings.Android/Sentry.Bindings.Android.csproj

@@ -3,7 +3,7 @@
     <TargetFramework>net7.0-android</TargetFramework>
     <!-- BG8605 and BG8606 happen because there's a missing androidx.lifecycle dependency, but we don't need it here.  (The native Android Sentry SDK will use it if it exists.) -->
     <NoWarn>$(NoWarn);BG8605;BG8606</NoWarn>
-    <SentryAndroidSdkVersion>6.33.1</SentryAndroidSdkVersion>
+    <SentryAndroidSdkVersion>6.34.0</SentryAndroidSdkVersion>
     <SentryAndroidSdkDirectory>$(BaseIntermediateOutputPath)sdks\Sentry\Android\$(SentryAndroidSdkVersion)\</SentryAndroidSdkDirectory>
     <Description>.NET Bindings for the Sentry Android SDK</Description>
   </PropertyGroup>

src/Sentry/Internal/Hub.cs

@@ -421,12 +421,12 @@ public SentryId CaptureEvent(SentryEvent evt, Scope? scope = null, Hint? hint =
             actualScope.LastEventId = id;
             actualScope.SessionUpdate = null;
 
-            if (evt.HasTerminalException())
+            if (evt.HasTerminalException() && actualScope.Transaction is { } transaction)
             {
                 // Event contains a terminal exception -> finish any current transaction as aborted
                 // Do this *after* the event was captured, so that the event is still linked to the transaction.
                 _options.LogDebug("Ending transaction as Aborted, due to unhandled exception.");
-                actualScope.Transaction?.Finish(SpanStatus.Aborted);
+                transaction.Finish(SpanStatus.Aborted);
             }
 
             return id;

test/Sentry.AspNetCore.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt

@@ -53,6 +53,7 @@ namespace Sentry.AspNetCore
     {
         public SentryAspNetCoreOptions() { }
         public bool AdjustStandardEnvironmentNameCasing { get; set; }
+        public bool AutoRegisterTracing { get; set; }
         public bool FlushOnCompletedRequest { get; set; }
         public bool IncludeActivityData { get; set; }
         public Sentry.Extensibility.RequestSize MaxRequestBodySize { get; set; }

test/Sentry.AspNetCore.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt

@@ -53,6 +53,7 @@ namespace Sentry.AspNetCore
     {
         public SentryAspNetCoreOptions() { }
         public bool AdjustStandardEnvironmentNameCasing { get; set; }
+        public bool AutoRegisterTracing { get; set; }
         public bool FlushOnCompletedRequest { get; set; }
         public bool IncludeActivityData { get; set; }
         public Sentry.Extensibility.RequestSize MaxRequestBodySize { get; set; }

test/Sentry.AspNetCore.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -53,6 +53,7 @@ namespace Sentry.AspNetCore
     {
         public SentryAspNetCoreOptions() { }
         public bool AdjustStandardEnvironmentNameCasing { get; set; }
+        public bool AutoRegisterTracing { get; set; }
         public bool FlushOnCompletedRequest { get; set; }
         public bool IncludeActivityData { get; set; }
         public Sentry.Extensibility.RequestSize MaxRequestBodySize { get; set; }