Add non allocating ConfigureScope overload (#4244)

Author: KnapSac

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Added non-allocating `ConfigureScope` and `ConfigureScopeAsync` overloads ([#4244](https://github.com/getsentry/sentry-dotnet/pull/4244))
+
 ### Fixes
 
 - The HTTP instrumentation uses the span created for the outgoing request in the sentry-trace header, fixing the parent-child relationship between client and server ([#4264](https://github.com/getsentry/sentry-dotnet/pull/4264))

src/Sentry.AspNetCore/SentryMiddleware.cs

@@ -118,7 +118,7 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
             context.Items.TryAdd(BaggageHeaderItemKey, baggageHeader);
             context.Items.TryAdd(TransactionContextItemKey, transactionContext);
 
-            hub.ConfigureScope(scope =>
+            hub.ConfigureScope(static (scope, arg) =>
             {
                 // At the point lots of stuff from the request are not yet filled
                 // Identity for example is added later on in the pipeline
@@ -131,16 +131,16 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
                 // when the event fires.  Use `activeScope`, not `scope` or `hub`.
                 scope.OnEvaluating += (_, activeScope) =>
                 {
-                    SyncOptionsScope(activeScope);
-                    PopulateScope(context, activeScope);
+                    arg.middleware.SyncOptionsScope(activeScope);
+                    arg.middleware.PopulateScope(arg.context, activeScope);
                 };
-            });
+            }, (middleware: this, context));
 
             // Pre-create the Sentry Event ID and save it on the scope it so it's available throughout the pipeline,
             // even if there's no event actually being sent to Sentry.  This allows for things like a custom exception
             // handler page to access the event ID, enabling user feedback, etc.
             var eventId = SentryId.Create();
-            hub.ConfigureScope(scope => scope.LastEventId = eventId);
+            hub.ConfigureScope(static (scope, eventId) => scope.LastEventId = eventId, eventId);
 
             try
             {
@@ -167,7 +167,7 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
                 {
                     // The middleware pipeline finishes up before the Otel Activity.OnEnd callback is invoked so we need
                     // so save a copy of the scope that can be restored by our SentrySpanProcessor
-                    hub.ConfigureScope(scope => activity.SetFused(scope));
+                    hub.ConfigureScope(static (scope, activity) => activity.SetFused(scope), activity);
                 }
 
                 // When an exception was handled by other component (i.e: UseExceptionHandler feature).
@@ -179,12 +179,12 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
                         "The web server likely returned a customized error page as a result of this exception.";
 
 #if NET6_0_OR_GREATER
-                    hub.ConfigureScope(scope =>
+                    hub.ConfigureScope(static (scope, arg) =>
                     {
                         scope.ExceptionProcessors.Add(
-                            new ExceptionHandlerFeatureProcessor(originalMethod, exceptionFeature)
+                            new ExceptionHandlerFeatureProcessor(arg.originalMethod, arg.exceptionFeature)
                             );
-                    });
+                    }, (originalMethod, exceptionFeature));
 #endif
                     CaptureException(exceptionFeature.Error, eventId, "IExceptionHandlerFeature", description);
                 }

src/Sentry.AspNetCore/SentryTracingMiddleware.cs

@@ -130,10 +130,7 @@ public async Task InvokeAsync(HttpContext context)
 
         // Expose the transaction on the scope so that the user
         // can retrieve it and start child spans off of it.
-        hub.ConfigureScope(scope =>
-        {
-            scope.Transaction = transaction;
-        });
+        hub.ConfigureScope(static (scope, transaction) => scope.Transaction = transaction, transaction);
 
         Exception? exception = null;
         try

src/Sentry.Extensions.Logging/SentryLoggerProvider.cs

@@ -48,7 +48,7 @@ internal SentryLoggerProvider(
         if (hub.IsEnabled)
         {
             _scope = hub.PushScope();
-            hub.ConfigureScope(s =>
+            hub.ConfigureScope(static s =>
             {
                 if (s.Sdk is { } sdk)
                 {

src/Sentry.OpenTelemetry/AspNetCoreEnricher.cs

@@ -10,13 +10,13 @@ public void Enrich(ISpan span, Activity activity, IHub hub, SentryOptions? optio
     {
         if (options?.SendDefaultPii is true)
         {
-            hub.ConfigureScope(scope =>
+            hub.ConfigureScope(static (scope, enricher) =>
             {
-                if (!scope.HasUser() && _userFactory.Create() is { } user)
+                if (!scope.HasUser() && enricher._userFactory.Create() is { } user)
                 {
                     scope.User = user;
                 }
-            });
+            }, this);
         }
     }
 }

src/Sentry.OpenTelemetry/SentrySpanProcessor.cs

@@ -172,7 +172,7 @@ private void CreateRootSpan(Activity data)
             tracer.Contexts.Trace.Origin = OpenTelemetryOrigin;
             tracer.StartTimestamp = data.StartTimeUtc;
         }
-        _hub.ConfigureScope(scope => scope.Transaction = transaction);
+        _hub.ConfigureScope(static (scope, transaction) => scope.Transaction = transaction, transaction);
         transaction.SetFused(data);
         _map[data.SpanId] = transaction;
     }

src/Sentry/Extensibility/DisabledHub.cs

@@ -30,11 +30,23 @@ public void ConfigureScope(Action<Scope> configureScope)
     {
     }
 
+    /// <summary>
+    /// No-Op.
+    /// </summary>
+    public void ConfigureScope<TArg>(Action<Scope, TArg> configureScope, TArg arg)
+    {
+    }
+
     /// <summary>
     /// No-Op.
     /// </summary>
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope) => Task.CompletedTask;
 
+    /// <summary>
+    /// No-Op.
+    /// </summary>
+    public Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg) => Task.CompletedTask;
+
     /// <summary>
     /// No-Op.
     /// </summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -39,13 +39,27 @@ private HubAdapter() { }
     public void ConfigureScope(Action<Scope> configureScope)
         => SentrySdk.ConfigureScope(configureScope);
 
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// </summary>
+    [DebuggerStepThrough]
+    public void ConfigureScope<TArg>(Action<Scope, TArg> configureScope, TArg arg)
+        => SentrySdk.ConfigureScope(configureScope, arg);
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>
     [DebuggerStepThrough]
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         => SentrySdk.ConfigureScopeAsync(configureScope);
 
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// </summary>
+    [DebuggerStepThrough]
+    public Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg)
+        => SentrySdk.ConfigureScopeAsync(configureScope, arg);
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>

src/Sentry/HubExtensions.cs

@@ -56,14 +56,11 @@ public static ITransactionTracer StartTransaction(
     /// </summary>
     public static ISpan StartSpan(this IHub hub, string operation, string description)
     {
-        ITransactionTracer? currentTransaction = null;
-        hub.ConfigureScope(s => currentTransaction = s.Transaction);
-        return currentTransaction is { } transaction
+        return hub.GetTransaction() is { } transaction
             ? transaction.StartChild(operation, description)
             : hub.StartTransaction(operation, description); // this is actually in the wrong order but changing it may break other things
     }
 
-
     /// <summary>
     /// Adds a breadcrumb to the current scope.
     /// </summary>
@@ -158,8 +155,8 @@ public static void AddBreadcrumb(
         }
 
         hub.ConfigureScope(
-            s => s.AddBreadcrumb(breadcrumb, hint ?? new SentryHint())
-            );
+            static (s, arg) => s.AddBreadcrumb(arg.breadcrumb, arg.hint ?? new SentryHint()),
+            (breadcrumb, hint));
     }
 
     /// <summary>
@@ -175,13 +172,13 @@ public static void AddBreadcrumb(
     /// like Loggers which guarantee log messages are not lost.
     /// </remarks>
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public static void LockScope(this IHub hub) => hub.ConfigureScope(c => c.Locked = true);
+    public static void LockScope(this IHub hub) => hub.ConfigureScope(static s => s.Locked = true);
 
     /// <summary>
     /// Unlocks the current scope to allow subsequent calls to <see cref="ISentryScopeManager.PushScope"/> create new scopes.
     /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public static void UnlockScope(this IHub hub) => hub.ConfigureScope(c => c.Locked = false);
+    public static void UnlockScope(this IHub hub) => hub.ConfigureScope(static s => s.Locked = false);
 
     private sealed class LockedScope : IDisposable
     {
@@ -247,6 +244,11 @@ internal static ITransactionTracer StartTransaction(
 
     internal static ITransactionTracer? GetTransaction(this IHub hub)
     {
+        if (hub is Hub fullHub)
+        {
+            return fullHub.ScopeManager.GetCurrent().Key.Transaction;
+        }
+
         ITransactionTracer? transaction = null;
         hub.ConfigureScope(scope => transaction = scope.Transaction);
         return transaction;

src/Sentry/ISentryScopeManager.cs

@@ -10,18 +10,33 @@ namespace Sentry;
 public interface ISentryScopeManager
 {
     /// <summary>
-    /// Configures the current scope.
+    /// Configures the current scope through the callback.
     /// </summary>
-    /// <param name="configureScope">The configure scope.</param>
+    /// <param name="configureScope">The configure scope callback.</param>
     public void ConfigureScope(Action<Scope> configureScope);
 
     /// <summary>
-    /// Asynchronously configure the current scope.
+    /// Configures the current scope through the callback.
     /// </summary>
-    /// <param name="configureScope">The configure scope.</param>
+    /// <param name="configureScope">The configure scope callback.</param>
+    /// <param name="arg">The argument to pass to the configure scope callback.</param>
+    public void ConfigureScope<TArg>(Action<Scope, TArg> configureScope, TArg arg);
+
+    /// <summary>
+    /// Configures the current scope through the callback asynchronously.
+    /// </summary>
+    /// <param name="configureScope">The configure scope callback.</param>
     /// <returns>A task that completes when the callback is done or a completed task if the SDK is disabled.</returns>
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope);
 
+    /// <summary>
+    /// Configures the current scope through the callback asynchronously.
+    /// </summary>
+    /// <param name="configureScope">The configure scope callback.</param>
+    /// <param name="arg">The argument to pass to the configure scope callback.</param>
+    /// <returns>A task that completes when the callback is done or a completed task if the SDK is disabled.</returns>
+    public Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg);
+
     /// <summary>
     /// Sets a tag on the current scope.
     /// </summary>