fix(ci): make the benchmark table more compact

Author: xHeaven

tests/Benchmark/Extension/MarkdownRenderer.php

@@ -17,6 +17,10 @@
 
 final readonly class MarkdownRenderer implements RendererInterface
 {
+    private const array COMPACT_HEADERS = ['Benchmark', 'Set', 'Mem. Peak', 'Time', 'Variability'];
+
+    private const array COMPACT_SOURCE_COLUMNS = ['benchmark', 'subject', 'set', 'mem_peak', 'mode', 'rstdev'];
+
     public function __construct(
         private OutputInterface $output,
         private Printer $printer,
@@ -71,11 +75,14 @@ private function renderTable(Table $table): array
             return $lines;
         }
 
+        $rows = array_map($this->renderTableRow(...), $table->rows());
+        [$columns, $rows] = $this->compactAggregateReportTable($columns, $rows);
+
         $lines[] = $this->renderRow($columns);
         $lines[] = $this->renderSeparatorRow($columns);
 
-        foreach ($table as $row) {
-            $lines[] = $this->renderDataRow($row);
+        foreach ($rows as $row) {
+            $lines[] = $this->renderRow($row);
         }
 
         $lines[] = '';
@@ -96,11 +103,52 @@ private function renderSeparatorRow(array $columns): string
         ));
     }
 
-    private function renderDataRow(TableRow $row): string
+    private function renderTableRow(TableRow $row): array
+    {
+        return array_values(array_map($this->formatCell(...), iterator_to_array($row)));
+    }
+
+    private function compactAggregateReportTable(array $columns, array $rows): array
+    {
+        $columnIndexes = $this->resolveCompactSourceColumnIndexes($columns);
+
+        if ($columnIndexes === null) {
+            return [$columns, $rows];
+        }
+
+        $rows = array_map(function (array $row) use ($columnIndexes): array {
+            $set = trim((string) $row[$columnIndexes['set']]);
+
+            return [
+                sprintf('%s(%s)', $row[$columnIndexes['benchmark']], $row[$columnIndexes['subject']]),
+                $set === '' ? '-' : $set,
+                $row[$columnIndexes['mem_peak']],
+                $row[$columnIndexes['mode']],
+                $row[$columnIndexes['rstdev']],
+            ];
+        }, $rows);
+
+        return [self::COMPACT_HEADERS, $rows];
+    }
+
+    private function resolveCompactSourceColumnIndexes(array $columns): ?array
     {
-        $cells = array_map($this->formatCell(...), iterator_to_array($row));
+        $columnIndexes = array_flip($columns);
+
+        foreach (self::COMPACT_SOURCE_COLUMNS as $column) {
+            if (! array_key_exists($column, $columnIndexes)) {
+                return null;
+            }
+        }
 
-        return $this->renderRow($cells);
+        return [
+            'benchmark' => $columnIndexes['benchmark'],
+            'subject' => $columnIndexes['subject'],
+            'set' => $columnIndexes['set'],
+            'mem_peak' => $columnIndexes['mem_peak'],
+            'mode' => $columnIndexes['mode'],
+            'rstdev' => $columnIndexes['rstdev'],
+        ];
     }
 
     private function formatCell(Node $node): string

tests/Benchmark/Extension/MarkdownRendererTest.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Benchmark\Extension;
+
+use PhpBench\Expression\Printer\BareValuePrinter;
+use PhpBench\Registry\Config;
+use PhpBench\Report\Model\Builder\ReportBuilder;
+use PhpBench\Report\Model\Builder\TableBuilder;
+use PhpBench\Report\Model\Reports;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Output\BufferedOutput;
+
+final class MarkdownRendererTest extends TestCase
+{
+    #[Test]
+    public function it_renders_a_compact_aggregate_report_table(): void
+    {
+        $output = new BufferedOutput();
+        $renderer = new MarkdownRenderer($output, new BareValuePrinter());
+
+        $table = TableBuilder::create()
+            ->withTitle('Benchmark Results')
+            ->addRowArray([
+                'benchmark' => 'ContainerBench',
+                'subject' => 'benchAutowireSimple',
+                'set' => '',
+                'revs' => 1000,
+                'its' => 5,
+                'mem_peak' => '3.952mb 0.00%',
+                'mode' => '4.187μs +0.17%',
+                'rstdev' => '±2.05% +108.06%',
+            ])
+            ->build();
+
+        $reports = Reports::fromReport(ReportBuilder::create()->addObject($table)->build());
+
+        $renderer->render($reports, new Config('markdown', ['file' => null]));
+
+        $this->assertSame(<<<'MARKDOWN'
+        ## Benchmark Results
+
+        | Benchmark | Set | Mem. Peak | Time | Variability |
+        | --------- | --- | --------- | ---- | ----------- |
+        | ContainerBench(benchAutowireSimple) | - | 3.952mb 0.00% | 4.187μs +0.17% | ±2.05% +108.06% |
+
+
+        MARKDOWN,
+
+        $output->fetch());
+    }
+
+    #[Test]
+    public function it_keeps_non_aggregate_table_columns_unchanged(): void
+    {
+        $output = new BufferedOutput();
+        $renderer = new MarkdownRenderer($output, new BareValuePrinter());
+
+        $table = TableBuilder::create()
+            ->addRowArray([
+                'name' => 'Example',
+                'value' => '123',
+            ])
+            ->build();
+
+        $reports = Reports::fromReport(ReportBuilder::create()->addObject($table)->build());
+
+        $renderer->render($reports, new Config('markdown', ['file' => null]));
+
+        $this->assertSame(<<<'MARKDOWN'
+        | name | value |
+        | ---- | ----- |
+        | Example | 123 |
+
+
+        MARKDOWN, $output->fetch());
+    }
+}