Merge pull request #5628 from kenjis/add-spark-routes-filters

feat: `spark routes` shows filters

Author: kenjis

system/CodeIgniter.php

@@ -286,7 +286,7 @@ protected function initializeKint()
      * @throws Exception
      * @throws RedirectException
      *
-     * @return bool|mixed|RequestInterface|ResponseInterface
+     * @return bool|mixed|RequestInterface|ResponseInterface|void
      */
     public function run(?RouteCollectionInterface $routes = null, bool $returnResponse = false)
     {
@@ -703,7 +703,7 @@ public function displayPerformanceMetrics(string $output): string
      *
      * @throws RedirectException
      *
-     * @return string|string[]|null
+     * @return string|string[]|null Route filters, that is, the filters specified in the routes file
      */
     protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
     {

system/Commands/Utilities/Routes.php

@@ -15,6 +15,8 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\Commands\Utilities\Routes\AutoRouteCollector;
+use CodeIgniter\Commands\Utilities\Routes\FilterCollector;
+use CodeIgniter\Commands\Utilities\Routes\SampleURIGenerator;
 use Config\Services;
 
 /**
@@ -44,7 +46,7 @@ class Routes extends BaseCommand
      *
      * @var string
      */
-    protected $description = 'Displays all of user-defined routes. Does NOT display auto-detected routes.';
+    protected $description = 'Displays all routes.';
 
     /**
      * the Command's usage
@@ -86,18 +88,24 @@ public function run(array $params)
             'cli',
         ];
 
-        $tbody = [];
+        $tbody           = [];
+        $uriGenerator    = new SampleURIGenerator();
+        $filterCollector = new FilterCollector();
 
         foreach ($methods as $method) {
             $routes = $collection->getRoutes($method);
 
             foreach ($routes as $route => $handler) {
-                // filter for strings, as callbacks aren't displayable
                 if (is_string($handler) || $handler instanceof Closure) {
+                    $sampleUri = $uriGenerator->get($route);
+                    $filters   = $filterCollector->get($method, $sampleUri);
+
                     $tbody[] = [
                         strtoupper($method),
                         $route,
                         is_string($handler) ? $handler : '(Closure)',
+                        implode(' ', array_map('class_basename', $filters['before'])),
+                        implode(' ', array_map('class_basename', $filters['after'])),
                     ];
                 }
             }
@@ -109,13 +117,23 @@ public function run(array $params)
                 $collection->getDefaultController(),
                 $collection->getDefaultMethod()
             );
-            $tbody = [...$tbody, ...$autoRouteCollector->get()];
+            $autoRoutes = $autoRouteCollector->get();
+
+            foreach ($autoRoutes as &$routes) {
+                $filters  = $filterCollector->get('get', $uriGenerator->get($routes[1]));
+                $routes[] = implode(' ', array_map('class_basename', $filters['before']));
+                $routes[] = implode(' ', array_map('class_basename', $filters['after']));
+            }
+
+            $tbody = [...$tbody, ...$autoRoutes];
         }
 
         $thead = [
             'Method',
             'Route',
             'Handler',
+            'Before Filters',
+            'After Filters',
         ];
 
         CLI::table($tbody, $thead);

system/Commands/Utilities/Routes/FilterCollector.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities\Routes;
+
+use CodeIgniter\Config\Services;
+use CodeIgniter\Filters\Filters;
+use CodeIgniter\HTTP\Request;
+use CodeIgniter\Router\Router;
+
+/**
+ * Collects filters for a route.
+ */
+final class FilterCollector
+{
+    /**
+     * @param string $method HTTP method
+     * @param string $uri    URI path to find filters for
+     *
+     * @return array{before: list<string>, after: list<string>} array of filter alias or classname
+     */
+    public function get(string $method, string $uri): array
+    {
+        if ($method === 'cli') {
+            return [
+                'before' => [],
+                'after'  => [],
+            ];
+        }
+
+        $request = Services::request(null, false);
+        $request->setMethod($method);
+
+        $router  = $this->createRouter($request);
+        $filters = $this->createFilters($request);
+
+        $finder = new FilterFinder($router, $filters);
+
+        return $finder->find($uri);
+    }
+
+    private function createRouter(Request $request): Router
+    {
+        return new Router(Services::routes(), $request);
+    }
+
+    private function createFilters(Request $request): Filters
+    {
+        $config = config('Filters');
+
+        return new Filters($config, $request, Services::response());
+    }
+}

system/Commands/Utilities/Routes/FilterFinder.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities\Routes;
+
+use CodeIgniter\Filters\Filters;
+use CodeIgniter\Router\Exceptions\RedirectException;
+use CodeIgniter\Router\Router;
+use Config\Services;
+
+/**
+ * Finds filters.
+ */
+final class FilterFinder
+{
+    private Router $router;
+    private Filters $filters;
+
+    public function __construct(?Router $router = null, ?Filters $filters = null)
+    {
+        $this->router  = $router ?? Services::router();
+        $this->filters = $filters ?? Services::filters();
+    }
+
+    private function getRouteFilters(string $uri): array
+    {
+        $this->router->handle($uri);
+
+        $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
+        if (! $multipleFiltersEnabled) {
+            $filter = $this->router->getFilter();
+
+            return $filter === null ? [] : [$filter];
+        }
+
+        return $this->router->getFilters();
+    }
+
+    /**
+     * @param string $uri URI path to find filters for
+     *
+     * @return array{before: list<string>, after: list<string>} array of filter alias or classname
+     */
+    public function find(string $uri): array
+    {
+        $this->filters->reset();
+
+        // Add route filters
+        try {
+            $routeFilters = $this->getRouteFilters($uri);
+            $this->filters->enableFilters($routeFilters, 'before');
+            $this->filters->enableFilters($routeFilters, 'after');
+
+            $this->filters->initialize($uri);
+
+            return $this->filters->getFilters();
+        } catch (RedirectException $e) {
+            return [
+                'before' => [],
+                'after'  => [],
+            ];
+        }
+    }
+}

system/Commands/Utilities/Routes/SampleURIGenerator.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities\Routes;
+
+use CodeIgniter\Config\Services;
+use CodeIgniter\Router\RouteCollection;
+
+/**
+ * Generate a sample URI path from route key regex.
+ */
+final class SampleURIGenerator
+{
+    private RouteCollection $routes;
+
+    /**
+     * Sample URI path for placeholder.
+     *
+     * @var array<string, string>
+     */
+    private array $samples = [
+        'any'      => '123/abc',
+        'segment'  => 'abc_123',
+        'alphanum' => 'abc123',
+        'num'      => '123',
+        'alpha'    => 'abc',
+        'hash'     => 'abc_123',
+    ];
+
+    public function __construct(?RouteCollection $routes = null)
+    {
+        $this->routes = $routes ?? Services::routes();
+    }
+
+    /**
+     * @param string $routeKey route key regex
+     *
+     * @return string sample URI path
+     */
+    public function get(string $routeKey): string
+    {
+        $sampleUri = $routeKey;
+
+        foreach ($this->routes->getPlaceholders() as $placeholder => $regex) {
+            $sample = $this->samples[$placeholder] ?? '::unknown::';
+
+            $sampleUri = str_replace('(' . $regex . ')', $sample, $sampleUri);
+        }
+
+        // auto route
+        return str_replace('[/...]', '/1/2/3/4/5', $sampleUri);
+    }
+}

system/Filters/Filters.php

@@ -355,7 +355,7 @@ public function enableFilter(string $name, string $when = 'before')
     }
 
     /**
-     * Ensures that specific filters is on and enabled for the current request.
+     * Ensures that specific filters are on and enabled for the current request.
      *
      * Filters can have "arguments". This is done by placing a colon immediately
      * after the filter name, followed by a comma-separated list of arguments that

system/Router/RouteCollection.php

@@ -90,7 +90,7 @@ class RouteCollection implements RouteCollectionInterface
      * Defined placeholders that can be used
      * within the
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $placeholders = [
         'any'      => '.*',
@@ -238,6 +238,18 @@ public function addPlaceholder($placeholder, ?string $pattern = null): RouteColl
         return $this;
     }
 
+    /**
+     * For `spark routes`
+     *
+     * @return array<string, string>
+     *
+     * @internal
+     */
+    public function getPlaceholders(): array
+    {
+        return $this->placeholders;
+    }
+
     /**
      * Sets the default namespace to use for Controllers when no other
      * namespace has been specified.
@@ -429,7 +441,7 @@ public function getRoutes(?string $verb = null): array
         $collection = [];
 
         if (isset($this->routes[$verb])) {
-            // Keep current verb's routes at the beginning so they're matched
+            // Keep current verb's routes at the beginning, so they're matched
             // before any of the generic, "add" routes.
             if (isset($this->routes['*'])) {
                 $extraRules = array_diff_key($this->routes['*'], $this->routes[$verb]);

system/Router/Router.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\Router;
 
+use Closure;
 use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\HTTP\Request;
 use CodeIgniter\Router\Exceptions\RedirectException;
@@ -39,7 +40,7 @@ class Router implements RouterInterface
     /**
      * The name of the controller class.
      *
-     * @var string
+     * @var Closure|string
      */
     protected $controller;
 
@@ -181,7 +182,7 @@ public function handle(?string $uri = null)
     /**
      * Returns the filter info for the matched route, if any.
      *
-     * @return string
+     * @return string|null
      *
      * @deprecated Use getFilters()
      */
@@ -203,7 +204,7 @@ public function getFilters(): array
     /**
      * Returns the name of the matched controller.
      *
-     * @return mixed
+     * @return Closure|string
      */
     public function controllerName()
     {