Add non allocating ConfigureScope overload

Author: KnapSac

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/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>
+    internal 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>
+    internal Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg);
+
     /// <summary>
     /// Sets a tag on the current scope.
     /// </summary>

src/Sentry/Internal/Hub.cs

@@ -99,6 +99,18 @@ public void ConfigureScope(Action<Scope> configureScope)
         }
     }
 
+    public void ConfigureScope<TArg>(Action<Scope, TArg> configureScope, TArg arg)
+    {
+        try
+        {
+            ScopeManager.ConfigureScope(configureScope, arg);
+        }
+        catch (Exception e)
+        {
+            _options.LogError(e, "Failure to ConfigureScope");
+        }
+    }
+
     public async Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
     {
         try
@@ -111,6 +123,18 @@ public async Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         }
     }
 
+    public async Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg)
+    {
+        try
+        {
+            await ScopeManager.ConfigureScopeAsync(configureScope, arg).ConfigureAwait(false);
+        }
+        catch (Exception e)
+        {
+            _options.LogError(e, "Failure to ConfigureScopeAsync");
+        }
+    }
+
     public void SetTag(string key, string value) => ScopeManager.SetTag(key, value);
 
     public void UnsetTag(string key) => ScopeManager.UnsetTag(key);

src/Sentry/Internal/SentryScopeManager.cs

@@ -38,12 +38,24 @@ public void ConfigureScope(Action<Scope>? configureScope)
         configureScope?.Invoke(scope);
     }
 
+    public void ConfigureScope<TArg>(Action<Scope, TArg>? configureScope, TArg arg)
+    {
+        var (scope, _) = GetCurrent();
+        configureScope?.Invoke(scope, arg);
+    }
+
     public Task ConfigureScopeAsync(Func<Scope, Task>? configureScope)
     {
         var (scope, _) = GetCurrent();
         return configureScope?.Invoke(scope) ?? Task.CompletedTask;
     }
 
+    public Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task>? configureScope, TArg arg)
+    {
+        var (scope, _) = GetCurrent();
+        return configureScope?.Invoke(scope, arg) ?? Task.CompletedTask;
+    }
+
     public void SetTag(string key, string value)
     {
         var (scope, _) = GetCurrent();

src/Sentry/SentrySdk.cs

@@ -381,14 +381,32 @@ public static void ConfigureScope(Action<Scope> configureScope)
         => CurrentHub.ConfigureScope(configureScope);
 
     /// <summary>
-    /// Configures the scope asynchronously.
+    /// Configures the scope through the callback.
     /// </summary>
     /// <param name="configureScope">The configure scope callback.</param>
-    /// <returns>The Id of the event.</returns>
+    /// <param name="arg">The argument to pass to the configure scope callback.</param>
+    internal static void ConfigureScope<TArg>(Action<Scope, TArg> configureScope, TArg arg)
+        => CurrentHub.ConfigureScope(configureScope, arg);
+
+    /// <summary>
+    /// Configures the 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>
     [DebuggerStepThrough]
     public static Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         => CurrentHub.ConfigureScopeAsync(configureScope);
 
+    /// <summary>
+    /// Configures the 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>
+    [DebuggerStepThrough]
+    internal static Task ConfigureScopeAsync<TArg>(Func<Scope, TArg, Task> configureScope, TArg arg)
+        => CurrentHub.ConfigureScopeAsync(configureScope, arg);
+
     /// <summary>
     /// Sets a tag on the current scope.
     /// </summary>

test/Sentry.Tests/SentrySdkTests.cs

@@ -436,6 +436,36 @@ public void ConfigureScope_Sync_CallbackNeverInvoked()
         Assert.False(invoked);
     }
 
+    [Fact]
+    public void ConfigureScope_SyncWithArg_CallbackNeverInvoked()
+    {
+        var invoked = false;
+        SentrySdk.ConfigureScope((_,_) => invoked = true, "arg");
+        Assert.False(invoked);
+    }
+
+    [Fact]
+    public void ConfigureScope_SyncWithArg_ArgIsUsed()
+    {
+        using var _ = SentrySdk.Init(o =>
+        {
+            o.Dsn = ValidDsn;
+            o.AutoSessionTracking = false;
+            o.BackgroundWorker = Substitute.For<IBackgroundWorker>();
+            o.InitNativeSdks = false;
+        });
+
+        const string key = "key";
+        const string arg = "arg";
+
+        SentrySdk.ConfigureScope((s,a) => s.SetTag(key, a), arg);
+
+        string actual = null;
+        SentrySdk.ConfigureScope(s => actual = s.Tags[key]);
+
+        Assert.Equal(arg, actual);
+    }
+
     [SkippableFact]
     public async Task ConfigureScope_OnTask_PropagatedToCaller()
     {
@@ -668,6 +698,48 @@ await SentrySdk.ConfigureScopeAsync(_ =>
         Assert.False(invoked);
     }
 
+    [Fact]
+    public async Task ConfigureScope_AsyncWithArg_CallbackNeverInvoked()
+    {
+        var invoked = false;
+        await SentrySdk.ConfigureScopeAsync((_,_) =>
+        {
+            invoked = true;
+            return Task.CompletedTask;
+        }, "arg");
+        Assert.False(invoked);
+    }
+
+    [Fact]
+    public async Task ConfigureScope_AsyncWithArg_ArgIsUsed()
+    {
+        using var _ = SentrySdk.Init(o =>
+        {
+            o.Dsn = ValidDsn;
+            o.AutoSessionTracking = false;
+            o.BackgroundWorker = Substitute.For<IBackgroundWorker>();
+            o.InitNativeSdks = false;
+        });
+
+        const string key = "key";
+        const string arg = "arg";
+
+        await SentrySdk.ConfigureScopeAsync((s, a) =>
+        {
+            s.SetTag(key, a);
+            return Task.CompletedTask;
+        }, arg);
+
+        string actual = null;
+        await SentrySdk.ConfigureScopeAsync(s =>
+        {
+            actual = s.Tags[key];
+            return Task.CompletedTask;
+        });
+
+        Assert.Equal(arg, actual);
+    }
+
     [Fact]
     public void CaptureEvent_Instance_NoOp() => SentrySdk.CaptureEvent(new SentryEvent());