Skip to content

Commit

Permalink
DiagnosticSourceEventSource supports base class properties (#55613)
Browse files Browse the repository at this point in the history
Fixes #41300

Previously DiagnosticSourceEventSource would only iterate and recognize properties that were declared on the most derived type.
Now it can capture properties that were inherited from a base class too.
  • Loading branch information
noahfalk authored Jul 14, 2021
1 parent 7bd4724 commit afaf666
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1099,7 +1099,7 @@ private void Dispose()
{
TransformSpec? newSerializableArgs = null;
TypeInfo curTypeInfo = type.GetTypeInfo();
foreach (PropertyInfo property in curTypeInfo.DeclaredProperties)
foreach (PropertyInfo property in curTypeInfo.GetProperties(BindingFlags.Static | BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic))
{
// prevent TransformSpec from attempting to implicitly transform index properties
if (property.GetMethod == null || property.GetMethod!.GetParameters().Length > 0)
Expand Down Expand Up @@ -1319,7 +1319,7 @@ public static PropertyFetch FetcherForProperty(Type? type, string propertyName)
}
else
{
PropertyInfo? propertyInfo = typeInfo.GetDeclaredProperty(propertyName);
PropertyInfo? propertyInfo = typeInfo.GetProperty(propertyName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
if (propertyInfo == null)
{
Log.Message($"Property {propertyName} not found on {type}. Ensure the name is spelled correctly. If you published the application with PublishTrimmed=true, ensure the property was not trimmed away.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,40 @@ public void TestSpecificEvents()
}).Dispose();
}

/// <summary>
/// Tests that DiagnosticSourceEventSource can read property values from base classes
/// </summary>
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void TestBaseClassProperties()
{
RemoteExecutor.Invoke(() =>
{
using (var eventSourceListener = new TestDiagnosticSourceEventListener())
using (var diagnosticSourceListener = new DiagnosticListener("TestBaseClassProperties"))
{
Assert.Equal(0, eventSourceListener.EventCount);
eventSourceListener.Enable(
" TestBaseClassProperties/TestEvent1:Point_X=Point.X;Point_Y=Point.Y;Url_2=Url2\r\n");
/***************************************************************************************/
// Emit an event that matches the first pattern.
MyClass val = new MyDerivedClass() { Url = "MyUrl", Point = new MyPoint() { X = 3, Y = 5 }, Url2 = "Second url", AnotherString = "another" };
if (diagnosticSourceListener.IsEnabled("TestEvent1"))
diagnosticSourceListener.Write("TestEvent1", val);
Assert.Equal(1, eventSourceListener.EventCount); // Exactly one more event has been emitted.
Assert.Equal("TestBaseClassProperties", eventSourceListener.LastEvent.SourceName);
Assert.Equal("TestEvent1", eventSourceListener.LastEvent.EventName);
Assert.Equal(7, eventSourceListener.LastEvent.Arguments.Count);
Assert.Equal("another", eventSourceListener.LastEvent.Arguments["AnotherString"]);
Assert.Equal("3", eventSourceListener.LastEvent.Arguments["Point_X"]);
Assert.Equal("5", eventSourceListener.LastEvent.Arguments["Point_Y"]);
Assert.Equal("Second url", eventSourceListener.LastEvent.Arguments["Url_2"]);
eventSourceListener.ResetEventCountAndLastEvent();
}
}).Dispose();
}

/// <summary>
/// Test that things work properly for Linux newline conventions.
/// </summary>
Expand Down Expand Up @@ -1314,6 +1348,12 @@ internal class MyClass
public MyPoint Point { get; set; }
}

internal class MyDerivedClass : MyClass
{
public string Url2 { get; set; }
public string AnotherString { get; set; }
}

/// <summary>
/// classes for test data.
/// </summary>
Expand Down

0 comments on commit afaf666

Please sign in to comment.