Fix: braces from tag keys on DefaultSentryScopeStateProcessor. (#1183)

* Trim braces from tag keys on DefaultSentryScopeStateProcessor.
getsentry · Sep 9, 2021 · a12bb9f · a12bb9f
1 parent b55b55c
commit a12bb9f
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- Removed braces from tag keys on DefaultSentryScopeStateProcessor ([#1183](https://github.com/getsentry/sentry-dotnet/pull/1183))
 - Fix SQLClient unplanned behaviors ([#1179](https://github.com/getsentry/sentry-dotnet/pull/1179))
 - Add fallback to Scope Stack from AspNet ([#1180](https://github.com/getsentry/sentry-dotnet/pull/1180))
 

diff --git a/src/Sentry/DefaultSentryScopeStateProcessor.cs b/src/Sentry/DefaultSentryScopeStateProcessor.cs
@@ -11,6 +11,8 @@ namespace Sentry
     /// </summary>
     public class DefaultSentryScopeStateProcessor : ISentryScopeStateProcessor
     {
+        private static readonly char[] TrimFilter = { '{', '}' };
+
         /// <summary>
         /// Applies state onto a scope.
         /// </summary>
@@ -31,11 +33,9 @@ public void Apply(Scope scope, object state)
                         scope.SetTags(keyValStringObject
                             .Where(kv => !string.IsNullOrEmpty(kv.Value as string))
                             .Select(k => new KeyValuePair<string, string>(
-                                k.Key,
+                                k.Key.Trim(TrimFilter),
                                 // TODO: Candidate for serialization instead. Likely Contexts is a better fit.
                                 k.Value.ToString()!)));
-
-
                         break;
                     }
 #if !NET461

diff --git a/test/Sentry.Tests/DefaultSentryScopeStateProcessorTests.cs b/test/Sentry.Tests/DefaultSentryScopeStateProcessorTests.cs
@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+
+namespace Sentry.Tests
+{
+    public class DefaultSentryScopeStateProcessorTests
+    {
+        [Theory]
+        [InlineData("a", "a")]
+        [InlineData("{}", "")]
+        [InlineData("{OriginalFormat}", "OriginalFormat")]
+        [InlineData("OriginalFormat", "OriginalFormat")]
+        public void Apply_KeyValuePairObjectWithBraces_TagAddedWithoutBraces(string key, string expectedKey)
+        {
+            // Arrange
+            var expectedValue = "some string";
+            var list = new List<KeyValuePair<string, object>>
+            {
+                new(key, expectedValue)
+            };
+            var scopeStateProcessor = new DefaultSentryScopeStateProcessor();
+            var scope = new Scope();
+
+            // Act
+            scopeStateProcessor.Apply(scope, list);
+
+            // Assert
+            Assert.Equal(expectedKey, scope.Tags.First().Key);
+            Assert.Equal(expectedValue, scope.Tags.First().Value);
+        }
+    }
+}