Skip to content

refactor: enhance benchmark table display names #746

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

Merged
vbreuss merged 1 commit into from
May 1, 2026
Merged

refactor: enhance benchmark table display names #746

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
147 changes: 123 additions & 24 deletions Pipeline/Build.Benchmarks.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,16 @@ string CreateBenchmarkCommentBody(string[] files, string baselineResultsDirector
sb.AppendLine("<details>");
sb.AppendLine("<summary>Details</summary>");
BenchmarkTableParser parser = new(columnsToRemove);
List<TableRow> tableBuffer = new();
int tableMeanIndex = -1;
foreach (string line in lines)
{
if (line.StartsWith("```"))
{
FlushTableBuffer(sb, tableBuffer, tableMeanIndex, baselineRows, injectBaseline,
ref anyBaselineInjected);
tableMeanIndex = -1;

count++;
if (count == 1)
{
Expand All @@ -205,39 +211,24 @@ string CreateBenchmarkCommentBody(string[] files, string baselineResultsDirector
continue;
}

if (!parser.TryConsume(line, out _, out string filteredLine, out string[] filteredTokens))
if (!parser.TryConsume(line, out int rowIndex, out _, out string[] filteredTokens))
{
FlushTableBuffer(sb, tableBuffer, tableMeanIndex, baselineRows, injectBaseline,
ref anyBaselineInjected);
tableMeanIndex = -1;
sb.AppendLine(line);
continue;
}

bool isMockolateRow = filteredLine.Contains("_Mockolate", StringComparison.OrdinalIgnoreCase);

if (isMockolateRow && injectBaseline && parser.MeanIndex > 0)
if (rowIndex == 0)
{
string key = string.Join("|", filteredTokens.Take(parser.MeanIndex));
if (baselineRows.TryGetValue(key, out string[] baselineTokens) && baselineTokens.Length > 0)
{
string[] modifiedBaseline = new string[baselineTokens.Length];
for (int i = 0; i < baselineTokens.Length; i++)
{
string content = i == 0 ? "baseline*" : baselineTokens[i];
modifiedBaseline[i] = string.IsNullOrWhiteSpace(content) ? content : $"_{content}_";
}

sb.AppendLine(JoinTokens(modifiedBaseline));
anyBaselineInjected = true;
}
tableMeanIndex = parser.MeanIndex;
}

if (isMockolateRow)
{
MakeLineBold(sb, filteredLine);
continue;
}

sb.AppendLine(filteredLine);
tableBuffer.Add(new TableRow(rowIndex, filteredTokens));
}

FlushTableBuffer(sb, tableBuffer, tableMeanIndex, baselineRows, injectBaseline, ref anyBaselineInjected);
}

if (anyBaselineInjected)
Expand All @@ -251,6 +242,112 @@ string CreateBenchmarkCommentBody(string[] files, string baselineResultsDirector
return body;
}

static void FlushTableBuffer(StringBuilder sb, List<TableRow> tableBuffer, int meanIndex,
Dictionary<string, string[]> baselineRows, bool injectBaseline, ref bool anyBaselineInjected)
{
if (tableBuffer.Count == 0)
{
return;
}

string commonPrefix = FindCommonRowPrefix(tableBuffer);

foreach (TableRow row in tableBuffer)
{
string[] displayTokens = ApplyHeaderAndPrefixStripping(row, commonPrefix);
string displayLine = JoinTokens(displayTokens);

Comment thread
vbreuss marked this conversation as resolved.
bool isMockolateRow = row.RowIndex >= BenchmarkTableParser.DataRowStartIndex
&& row.Tokens.Length > 0
&& row.Tokens[0].Contains("_Mockolate", StringComparison.OrdinalIgnoreCase);

if (isMockolateRow && injectBaseline && meanIndex > 0)
{
string key = string.Join("|", row.Tokens.Take(meanIndex));
if (baselineRows.TryGetValue(key, out string[] baselineTokens) && baselineTokens.Length > 0)
{
string[] modifiedBaseline = new string[baselineTokens.Length];
for (int i = 0; i < baselineTokens.Length; i++)
{
string content = i == 0 ? "baseline*" : baselineTokens[i];
modifiedBaseline[i] = string.IsNullOrWhiteSpace(content) ? content : $"_{content}_";
}

sb.AppendLine(JoinTokens(modifiedBaseline));
anyBaselineInjected = true;
}
}

if (isMockolateRow)
{
MakeLineBold(sb, displayLine);
}
else
{
sb.AppendLine(displayLine);
}
}

tableBuffer.Clear();
}

static string[] ApplyHeaderAndPrefixStripping(TableRow row, string commonPrefix)
{
if (commonPrefix == null || row.Tokens.Length == 0)
{
return row.Tokens;
}

string[] result = (string[])row.Tokens.Clone();
if (row.RowIndex == 0)
{
result[0] = commonPrefix.TrimEnd('_');
}
else if (row.RowIndex >= BenchmarkTableParser.DataRowStartIndex
&& result[0].StartsWith(commonPrefix, StringComparison.Ordinal))
{
result[0] = result[0].Substring(commonPrefix.Length);
}

return result;
Comment thread
vbreuss marked this conversation as resolved.
}

static string FindCommonRowPrefix(List<TableRow> rows)
{
string prefix = null;
foreach (TableRow row in rows)
{
if (row.RowIndex < BenchmarkTableParser.DataRowStartIndex)
{
continue;
}

if (row.Tokens.Length == 0)
{
return null;
}

string name = row.Tokens[0];
int underscoreIdx = name.IndexOf('_');
if (underscoreIdx <= 0)
{
return null;
}

string thisPrefix = name.Substring(0, underscoreIdx + 1);
if (prefix == null)
{
prefix = thisPrefix;
}
else if (!string.Equals(prefix, thisPrefix, StringComparison.Ordinal))
{
return null;
}
}

return prefix;
}

static Dictionary<string, string[]> LoadBaselineRows(string baselineFile, string[] columnsToRemove)
{
Dictionary<string, string[]> result = new();
Expand Down Expand Up @@ -364,6 +461,8 @@ static void MakeLineBold(StringBuilder sb, string line)
sb.AppendLine();
}

sealed record TableRow(int RowIndex, string[] Tokens);

/// <summary>
/// Parses the markdown tables produced by BenchmarkDotNet's GitHub exporter.
/// Tables are framed by a header row (index 0), a separator row like <c>|---|---|</c> (index 1), and one or more
Expand Down