Skip to content

[efficiency-improver] perf: single-pass PropertyBag walk in JUnitReport TestResultCapture #9018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Evangelink wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −27
Draft

[efficiency-improver] perf: single-pass PropertyBag walk in JUnitReport TestResultCapture #9018

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 45 additions & 27 deletions src/Platform/Microsoft.Testing.Extensions.JUnitReport/TestResultCapture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,55 @@ public static ParentChainEntry GetParentChainEntry(TestNodeUpdateMessage update)
public static CapturedTestResult? TryCapture(TestNodeUpdateMessage update)
{
TestNode node = update.TestNode;
TestNodeStateProperty? state = node.Properties.SingleOrDefault<TestNodeStateProperty>();

// Single-pass collection of all required properties — replaces 5 × SingleOrDefault<T>()
// + 1 × foreach/GetEnumerator() with one zero-allocation GetStructEnumerator() pass,
// saving 5 linked-list traversals and 1 IEnumerator<IProperty> heap allocation per
// terminal test result. Singleton-typed properties use the local GetSingleOrDefaultValue
// helper to preserve the throw-on-duplicate invariant that SingleOrDefault<T>() provided;
Comment on lines +42 to +46
// TestMetadataProperty is intentionally multi-valued and accumulates into a list.
TestNodeStateProperty? state = null;
TimingProperty? timing = null;
TestMethodIdentifierProperty? identifier = null;
StandardOutputProperty? standardOutput = null;
StandardErrorProperty? standardError = null;
List<KeyValuePair<string, string>>? traits = null;

PropertyBag.PropertyBagEnumerator enumerator = node.Properties.GetStructEnumerator();
while (enumerator.MoveNext())
{
switch (enumerator.Current)
{
case TestNodeStateProperty s: state = GetSingleOrDefaultValue(state, s); break;
case TimingProperty t: timing = GetSingleOrDefaultValue(timing, t); break;
case TestMethodIdentifierProperty m: identifier = GetSingleOrDefaultValue(identifier, m); break;
case StandardOutputProperty so: standardOutput = GetSingleOrDefaultValue(standardOutput, so); break;
case StandardErrorProperty se: standardError = GetSingleOrDefaultValue(standardError, se); break;
case TestMetadataProperty meta:
// Trait keys and values are test-controlled so we truncate them to
// bound the size of the in-memory result list and generated XML.
traits ??= [];
traits.Add(new KeyValuePair<string, string>(
Truncate(meta.Key, MaxTraitFieldLength)!,
Truncate(meta.Value, MaxTraitFieldLength)!));
break;
}
}

static TProperty GetSingleOrDefaultValue<TProperty>(TProperty? existingProperty, TProperty property)
where TProperty : IProperty
=> existingProperty is not null
? throw new InvalidOperationException($"Found multiple properties of type '{typeof(TProperty)}'.")
: property;

if (state is null or DiscoveredTestNodeStateProperty or InProgressTestNodeStateProperty)
{
return null;
}

string outcome = ClassifyOutcome(state);

TimingProperty? timing = node.Properties.SingleOrDefault<TimingProperty>();
TimeSpan duration = timing?.GlobalTiming.Duration ?? TimeSpan.Zero;

(string? className, string? methodName) = GetClassAndMethodName(node);
(string? className, string? methodName) = GetClassAndMethodName(identifier);

string? errorMessage = state.Explanation;
string? stackTrace = null;
Expand All @@ -72,24 +109,6 @@ public static ParentChainEntry GetParentChainEntry(TestNodeUpdateMessage update)
exceptionType = exception.GetType().FullName;
}

string? stdout = node.Properties.SingleOrDefault<StandardOutputProperty>()?.StandardOutput;
string? stderr = node.Properties.SingleOrDefault<StandardErrorProperty>()?.StandardError;

// Collect traits without using LINQ to avoid an enumerator allocation per node.
// Trait keys and values are also test-controlled so we truncate them as well to
// bound the size of the in-memory result list and generated XML.
List<KeyValuePair<string, string>>? traits = null;
foreach (IProperty p in node.Properties)
{
if (p is TestMetadataProperty meta)
{
traits ??= [];
traits.Add(new KeyValuePair<string, string>(
Truncate(meta.Key, MaxTraitFieldLength)!,
Truncate(meta.Value, MaxTraitFieldLength)!));
}
}

return new CapturedTestResult
{
// Identity fields are test-controlled and can be unbounded (e.g. very long
Expand All @@ -111,8 +130,8 @@ public static ParentChainEntry GetParentChainEntry(TestNodeUpdateMessage update)
ErrorMessage = Truncate(errorMessage, MaxMessageLength),
ExceptionType = exceptionType,
StackTrace = Truncate(stackTrace, MaxStackTraceLength),
StandardOutput = Truncate(stdout, MaxStandardStreamLength),
StandardError = Truncate(stderr, MaxStandardStreamLength),
StandardOutput = Truncate(standardOutput?.StandardOutput, MaxStandardStreamLength),
StandardError = Truncate(standardError?.StandardError, MaxStandardStreamLength),
Traits = traits,
};
}
Expand All @@ -137,9 +156,8 @@ _ when Array.IndexOf(TestNodePropertiesCategories.WellKnownTestNodeTestRunOutcom
_ => throw ApplicationStateGuard.Unreachable(),
};

private static (string? ClassName, string? MethodName) GetClassAndMethodName(TestNode node)
private static (string? ClassName, string? MethodName) GetClassAndMethodName(TestMethodIdentifierProperty? identifier)
{
TestMethodIdentifierProperty? identifier = node.Properties.SingleOrDefault<TestMethodIdentifierProperty>();
if (identifier is null)
{
return (null, null);
Expand Down
Loading