Fix TraceSwitch to synchronize the Value and Level properties (#89278)

dotnet · Jul 26, 2023 · d4d0812 · d4d0812
1 parent e1ee453
commit d4d0812
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 2 deletions.
diff --git a/...raries/Microsoft.Extensions.Configuration.Binder/tests/Common/ConfigurationBinderTests.cs b/...raries/Microsoft.Extensions.Configuration.Binder/tests/Common/ConfigurationBinderTests.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
 using System.Reflection;
@@ -2030,6 +2031,26 @@ public void ComplexObj_As_Enumerable_Element()
             ValidateGeolocation(obj);
         }
 
+        [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsNotBrowser))]
+        public void TraceSwitchTest()
+        {
+            var dic = new Dictionary<string, string>
+            {
+                {"TraceSwitch:Level", "Info"}
+            };
+            var configurationBuilder = new ConfigurationBuilder();
+            configurationBuilder.AddInMemoryCollection(dic);
+            var config = configurationBuilder.Build();
+
+            TraceSwitch ts = new(displayName: "TraceSwitch", description: "This switch is set via config.");
+            ConfigurationBinder.Bind(config, "TraceSwitch", ts);
+            Assert.Equal(TraceLevel.Info, ts.Level);
+#if NETCOREAPP
+            // Value property is not publicly exposed in .NET Framework.
+            Assert.Equal("Info", ts.Value);
+#endif // NETCOREAPP
+        }
+
         private void ValidateGeolocation(IGeolocation location)
         {
             Assert.Equal(3, location.Latitude);

diff --git a/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/Switch.cs b/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/Switch.cs
@@ -165,6 +165,18 @@ protected int SwitchSetting
 
         protected internal virtual string[]? GetSupportedAttributes() => null;
 
+        internal void SetSwitchValues(int switchSetting, string switchValueString)
+        {
+            Initialize();
+
+            Debug.Assert(switchValueString is not null, "Unexpected 'switchValueString' null value");
+            lock (InitializedLock)
+            {
+                _switchSetting = switchSetting;
+                _switchValueString = switchValueString;
+            }
+        }
+
         /// <summary>
         /// The default value assigned in the constructor.
         /// </summary>

diff --git a/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/TraceSwitch.cs b/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/TraceSwitch.cs
@@ -38,7 +38,7 @@ public TraceLevel Level
             {
                 if (value < TraceLevel.Off || value > TraceLevel.Verbose)
                     throw new ArgumentException(SR.TraceSwitchInvalidLevel);
-                SwitchSetting = (int)value;
+                SetSwitchValues((int)value, value.ToString());
             }
         }
 
@@ -93,7 +93,21 @@ protected override void OnSwitchSettingChanged()
 
         protected override void OnValueChanged()
         {
-            SwitchSetting = (int)Enum.Parse<TraceLevel>(Value, true);
+            // Parse the new value and set the switch setting accordingly. Parse should throw an exception if the value is invalid.
+            TraceLevel level = Enum.Parse<TraceLevel>(Value, true);
+
+            if (level < TraceLevel.Off)
+            {
+                level = TraceLevel.Off;
+            }
+            else if (level > TraceLevel.Verbose)
+            {
+                level = TraceLevel.Verbose;
+            }
+
+
+            // Update the switch value string accordingly.
+            SetSwitchValues((int)level, level.ToString());
         }
     }
 }
diff --git a/...agnostics.TraceSource/tests/System.Diagnostics.TraceSource.Tests/TraceSwitchClassTests.cs b/...agnostics.TraceSource/tests/System.Diagnostics.TraceSource.Tests/TraceSwitchClassTests.cs
@@ -75,5 +75,25 @@ public void SwitchSettingChangedTest()
             item.SetSwitchSetting((int)TraceLevel.Verbose + 1);
             Assert.Equal(TraceLevel.Verbose, item.Level);
         }
+
+        [Fact]
+        public void EnsureValueSynchronizedWIthLevel()
+        {
+            TraceSwitch ts = new TraceSwitch("Name", "Description");
+            Assert.Equal(TraceLevel.Off, ts.Level);
+            Assert.Equal("Off", ts.Value);
+
+            ts.Value = "1";
+            Assert.Equal(TraceLevel.Error, ts.Level);
+            Assert.Equal("Error", ts.Value);
+
+            ts.Level = TraceLevel.Warning;
+            Assert.Equal(TraceLevel.Warning, ts.Level);
+            Assert.Equal("Warning", ts.Value);
+
+            ts.Value = "Verbose";
+            Assert.Equal(TraceLevel.Verbose, ts.Level);
+            Assert.Equal("Verbose", ts.Value);
+        }
     }
 }