Improve visibility of benchmarks

This reorganises the benchmark structure, allowing us to have better
visibility and more easily filter on groups/variants.

Signed-off-by: Luís Cobucci <[email protected]>

Makefile

@@ -28,4 +28,4 @@ phpstan:
 
 .PHONY: phpbench
 phpbench:
-	@vendor/bin/phpbench run -l dots --report aggregate
+	@vendor/bin/phpbench run -l dots --report aggregate $(PHPBENCH_OPTIONS)

benchmark/RealLifeExampleBench.php → benchmark/DispatcherForBenchmark.php

@@ -3,15 +3,21 @@
 
 namespace FastRoute\Benchmark;
 
+use FastRoute\DataGenerator;
 use FastRoute\Dispatcher;
 use FastRoute\RouteCollector;
 
+use RuntimeException;
+
 use function FastRoute\simpleDispatcher;
 
-final class RealLifeExampleBench extends Benchmark
+/**
+ * @phpstan-type DispatcherOptions array{dataGenerator: class-string<DataGenerator>, dispatcher: class-string<Dispatcher>}
+ */
+final class DispatcherForBenchmark
 {
-    /** @inheritdoc */
-    protected function createDispatcher(array $options): Dispatcher
+    /** @param class-string<Dispatcher> $dispatcher */
+    public static function realLifeExample(string $dispatcher): Dispatcher
     {
         return simpleDispatcher(
             static function (RouteCollector $routes): void {
@@ -57,71 +63,39 @@ static function (RouteCollector $routes): void {
                 $routes->addRoute(['PUT', 'PATCH'], '/admin/category/{category_id:\d+}', ['name' => 'admin.category.update']);
                 $routes->addRoute('DELETE', '/admin/category/{category_id:\d+}', ['name' => 'admin.category.destroy']);
             },
-            $options,
+            self::resolveOptions($dispatcher),
         );
     }
 
-    /** @inheritdoc */
-    public function provideStaticRoutes(): iterable
-    {
-        yield 'first' => [
-            'method' => 'GET',
-            'route' => '/',
-            'result' => [Dispatcher::FOUND, ['name' => 'home'], []],
-        ];
-
-        yield 'last' => [
-            'method' => 'GET',
-            'route' => '/admin/category',
-            'result' => [Dispatcher::FOUND, ['name' => 'admin.category.index'], []],
-        ];
-
-        yield 'invalid-method' => [
-            'method' => 'PUT',
-            'route' => '/about-us',
-            'result' => [Dispatcher::METHOD_NOT_ALLOWED, ['GET']],
-        ];
-    }
-
-    /** @inheritdoc */
-    public function provideDynamicRoutes(): iterable
+    /** @param class-string<Dispatcher> $dispatcher */
+    public static function manyRoutes(string $dispatcher, int $routeCount = 400): Dispatcher
     {
-        yield 'first' => [
-            'method' => 'GET',
-            'route' => '/page/hello-word',
-            'result' => [Dispatcher::FOUND, ['name' => 'page.show'], ['page_slug' => 'hello-word']],
-        ];
-
-        yield 'last' => [
-            'method' => 'GET',
-            'route' => '/admin/category/123',
-            'result' => [Dispatcher::FOUND, ['name' => 'admin.category.show'], ['category_id' => '123']],
-        ];
-
-        yield 'invalid-method' => [
-            'method' => 'PATCH',
-            'route' => '/shop/category/123',
-            'result' => [Dispatcher::METHOD_NOT_ALLOWED, ['GET']],
-        ];
+        return simpleDispatcher(
+            static function (RouteCollector $routes) use ($routeCount): void {
+                for ($i = 0; $i < $routeCount; ++$i) {
+                    $routes->addRoute('GET', '/abc' . $i, ['name' => 'static-' . $i]);
+                    $routes->addRoute('GET', '/abc{foo}/' . $i, ['name' => 'not-static-' . $i]);
+                }
+            },
+            self::resolveOptions($dispatcher),
+        );
     }
 
-    /** @inheritdoc */
-    public function provideOtherScenarios(): iterable
+    /**
+     * @param class-string<Dispatcher> $dispatcher
+     *
+     * @return DispatcherOptions
+     */
+    private static function resolveOptions(string $dispatcher): array
     {
-        yield 'non-existent' => [
-            'method' => 'GET',
-            'route' => '/shop/product/awesome',
-            'result' => [Dispatcher::NOT_FOUND],
-        ];
+        $generator = match ($dispatcher) {
+            Dispatcher\GroupCountBased::class => DataGenerator\GroupCountBased::class,
+            Dispatcher\CharCountBased::class => DataGenerator\CharCountBased::class,
+            Dispatcher\GroupPosBased::class => DataGenerator\GroupPosBased::class,
+            Dispatcher\MarkBased::class => DataGenerator\MarkBased::class,
+            default => throw new RuntimeException('Unsupported dispatcher'),
+        };
 
-        yield 'longest-route' => [
-            'method' => 'GET',
-            'route' => '/shop/category/123/product/search/status:sale',
-            'result' => [
-                Dispatcher::FOUND,
-                ['name' => 'shop.category.product.search'],
-                ['category_id' => '123', 'filter_by' => 'status', 'filter_value' => 'sale'],
-            ],
-        ];
+        return ['dataGenerator' => $generator, 'dispatcher' => $dispatcher];
     }
 }

benchmark/RouteRegistrationBench.php

@@ -0,0 +1,41 @@
+<?php
+declare(strict_types=1);
+
+namespace FastRoute\Benchmark;
+
+use FastRoute\Dispatcher;
+use PhpBench\Attributes as Bench;
+
+#[Bench\Iterations(5)]
+#[Bench\Revs(100)]
+#[Bench\Warmup(3)]
+final class RouteRegistrationBench
+{
+    #[Bench\Subject]
+    #[Bench\Groups(['group_count'])]
+    public function groupCount(): void
+    {
+        DispatcherForBenchmark::realLifeExample(Dispatcher\GroupCountBased::class);
+    }
+
+    #[Bench\Subject]
+    #[Bench\Groups(['char_count'])]
+    public function charCount(): void
+    {
+        DispatcherForBenchmark::realLifeExample(Dispatcher\CharCountBased::class);
+    }
+
+    #[Bench\Subject]
+    #[Bench\Groups(['group_pos'])]
+    public function groupPos(): void
+    {
+        DispatcherForBenchmark::realLifeExample(Dispatcher\GroupPosBased::class);
+    }
+
+    #[Bench\Subject]
+    #[Bench\Groups(['mark'])]
+    public function mark(): void
+    {
+        DispatcherForBenchmark::realLifeExample(Dispatcher\MarkBased::class);
+    }
+}