Hook for BaseScope.Apply (#596)

getsentry · Nov 20, 2020 · f2abba1 · f2abba1
1 parent fc37c7a
commit f2abba1
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 35 deletions.
diff --git a/src/Sentry.Protocol/BaseScopeExtensions.cs b/src/Sentry.Protocol/BaseScopeExtensions.cs
@@ -2,7 +2,6 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Linq;
 using Sentry.Protocol;
 
 // ReSharper disable once CheckNamespace
@@ -308,38 +307,8 @@ public static void Apply(this BaseScope from, BaseScope to)
         /// <param name="state">The state object to apply.</param>
         public static void Apply(this BaseScope scope, object state)
         {
-            switch (state)
-            {
-                case string scopeString:
-                    // TODO: find unique key to support multiple single-string scopes
-                    scope.SetTag("scope", scopeString);
-                    break;
-                case IEnumerable<KeyValuePair<string, string>> keyValStringString:
-                    scope.SetTags(keyValStringString
-                        .Where(kv => !string.IsNullOrEmpty(kv.Value)));
-                    break;
-                case IEnumerable<KeyValuePair<string, object>> keyValStringObject:
-                    {
-                        scope.SetTags(keyValStringObject
-                            .Select(k => new KeyValuePair<string, string>(
-                                k.Key,
-                                k.Value?.ToString()))
-                            .Where(kv => !string.IsNullOrEmpty(kv.Value)));
-
-                        break;
-                    }
-#if HAS_VALUE_TUPLE
-                case ValueTuple<string, string> tupleStringString:
-                    if (!string.IsNullOrEmpty(tupleStringString.Item2))
-                    {
-                        scope.SetTag(tupleStringString.Item1, tupleStringString.Item2);
-                    }
-                    break;
-#endif
-                default:
-                    scope.SetExtra("state", state);
-                    break;
-            }
+            var processor = scope.ScopeOptions.SentryScopeProcessor ?? new DefaultSentryScopeProcessor();
+            processor.Apply(scope, state);
         }
     }
 }
diff --git a/src/Sentry.Protocol/DefaultSentryScopeProcessor.cs b/src/Sentry.Protocol/DefaultSentryScopeProcessor.cs
@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Sentry.Protocol
+{
+    public class DefaultSentryScopeProcessor : ISentryScopeProcessor
+    {
+        public void Apply(BaseScope scope, object state)
+        {
+            switch (state)
+            {
+                case string scopeString:
+                    // TODO: find unique key to support multiple single-string scopes
+                    scope.SetTag("scope", scopeString);
+                    break;
+                case IEnumerable<KeyValuePair<string, string>> keyValStringString:
+                    scope.SetTags(keyValStringString
+                        .Where(kv => !string.IsNullOrEmpty(kv.Value)));
+                    break;
+                case IEnumerable<KeyValuePair<string, object>> keyValStringObject:
+                {
+                    scope.SetTags(keyValStringObject
+                        .Select(k => new KeyValuePair<string, string>(
+                            k.Key,
+                            k.Value?.ToString()))
+                        .Where(kv => !string.IsNullOrEmpty(kv.Value)));
+
+                    break;
+                }
+#if HAS_VALUE_TUPLE
+                case ValueTuple<string, string> tupleStringString:
+                    if (!string.IsNullOrEmpty(tupleStringString.Item2))
+                    {
+                        scope.SetTag(tupleStringString.Item1, tupleStringString.Item2);
+                    }
+                    break;
+#endif
+                default:
+                    scope.SetExtra("state", state);
+                    break;
+            }
+        }
+    }
+}
diff --git a/src/Sentry.Protocol/IScopeOptions.cs b/src/Sentry.Protocol/IScopeOptions.cs
@@ -7,6 +7,11 @@ namespace Sentry.Protocol
     /// </summary>
     public interface IScopeOptions
     {
+        /// <summary>
+        /// Configured scope processor.
+        /// </summary>
+        ISentryScopeProcessor SentryScopeProcessor { get; set; }
+
         /// <summary>
         /// Gets or sets the maximum breadcrumbs.
         /// </summary>

diff --git a/src/Sentry.Protocol/ISentryScopeProcessor.cs b/src/Sentry.Protocol/ISentryScopeProcessor.cs
@@ -0,0 +1,7 @@
+namespace Sentry.Protocol
+{
+    public interface ISentryScopeProcessor
+    {
+        void Apply(BaseScope scope, object state);
+    }
+}
diff --git a/src/Sentry/Internal/SentryScopeManager.cs b/src/Sentry/Internal/SentryScopeManager.cs
@@ -58,9 +58,15 @@ public IDisposable PushScope<TState>(TState state)
 
             if (scope.Key.Locked)
             {
-                // TODO: keep state on current scope?
                 _options?.DiagnosticLogger?.LogDebug("Locked scope. No new scope pushed.");
-                return DisabledHub.Instance;
+
+                // Apply to current scope
+                if (state != null)
+                {
+                    scope.Key.Apply(state);
+                }
+
+                return new ScopeSnapshot(_options, currentScopeAndClientStack, this);
             }
 
             var clonedScope = scope.Key.Clone();

diff --git a/src/Sentry/SentryOptions.cs b/src/Sentry/SentryOptions.cs
@@ -60,6 +60,9 @@ public class SentryOptions : IScopeOptions
 
         internal ISentryHttpClientFactory SentryHttpClientFactory { get; set; }
 
+        /// <inheritdoc />
+        public ISentryScopeProcessor SentryScopeProcessor { get; set; } = new DefaultSentryScopeProcessor();
+
         /// <summary>
         /// A list of namespaces (or prefixes) considered not part of application code
         /// </summary>