From 6a98d493e40befd561dc0a66008c1f7812acfe79 Mon Sep 17 00:00:00 2001 From: Santiago San Martin Date: Tue, 4 Mar 2025 15:18:16 -0300 Subject: [PATCH] Add 'method' option to debug:router command to filter routes by HTTP method --- .../Bundle/FrameworkBundle/CHANGELOG.md | 1 + .../Command/RouterDebugCommand.php | 10 +++-- .../Console/Descriptor/Descriptor.php | 18 ++++++++- .../Descriptor/AbstractDescriptorTestCase.php | 16 ++++++++ .../Console/Descriptor/ObjectsProvider.php | 32 ++++++++++++++++ .../Descriptor/route_collection_2.json | 38 +++++++++++++++++++ .../Fixtures/Descriptor/route_collection_2.md | 37 ++++++++++++++++++ .../Descriptor/route_collection_2.txt | 7 ++++ .../Descriptor/route_collection_2.xml | 33 ++++++++++++++++ .../Descriptor/route_collection_3.json | 19 ++++++++++ .../Fixtures/Descriptor/route_collection_3.md | 18 +++++++++ .../Descriptor/route_collection_3.txt | 6 +++ .../Descriptor/route_collection_3.xml | 17 +++++++++ 13 files changed, 248 insertions(+), 4 deletions(-) create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.json create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.md create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.txt create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.xml create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.json create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.md create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.txt create mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.xml diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md index 17201aeaec284..8340a4970224e 100644 --- a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md +++ b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md @@ -13,6 +13,7 @@ CHANGELOG * Add `framework.validation.disable_translation` option * Add support for signal plain name in the `messenger.stop_worker_on_signals` configuration * Deprecate the `framework.validation.cache` option + * Add `--method` option to the `debug:router` command 7.2 --- diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php index 13a6f75d01230..e543771150fc5 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php +++ b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php @@ -55,6 +55,7 @@ protected function configure(): void new InputOption('show-aliases', null, InputOption::VALUE_NONE, 'Show aliases in overview'), new InputOption('format', null, InputOption::VALUE_REQUIRED, \sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), 'txt'), new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'), + new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Filter by HTTP method', '', ['GET', 'POST', 'PUT', 'DELETE', 'PATCH']), ]) ->setHelp(<<<'EOF' The %command.name% displays the configured routes: @@ -76,6 +77,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $io = new SymfonyStyle($input, $output); $name = $input->getArgument('name'); + $method = strtoupper($input->getOption('method')); $helper = new DescriptorHelper($this->fileLinkFormatter); $routes = $this->router->getRouteCollection(); $container = null; @@ -85,7 +87,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int if ($name) { $route = $routes->get($name); - $matchingRoutes = $this->findRouteNameContaining($name, $routes); + $matchingRoutes = $this->findRouteNameContaining($name, $routes, $method); if (!$input->isInteractive() && !$route && \count($matchingRoutes) > 1) { $helper->describe($io, $this->findRouteContaining($name, $routes), [ @@ -94,6 +96,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int 'show_controllers' => $input->getOption('show-controllers'), 'show_aliases' => $input->getOption('show-aliases'), 'output' => $io, + 'method' => $method, ]); return 0; @@ -124,17 +127,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int 'show_aliases' => $input->getOption('show-aliases'), 'output' => $io, 'container' => $container, + 'method' => $method, ]); } return 0; } - private function findRouteNameContaining(string $name, RouteCollection $routes): array + private function findRouteNameContaining(string $name, RouteCollection $routes, string $method): array { $foundRoutesNames = []; foreach ($routes as $routeName => $route) { - if (false !== stripos($routeName, $name)) { + if (false !== stripos($routeName, $name) && (!$method || !$route->getMethods() || \in_array($method, $route->getMethods(), true))) { $foundRoutesNames[] = $routeName; } } diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php index af5c3b10ac415..e76b742474a37 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php @@ -49,7 +49,7 @@ public function describe(OutputInterface $output, mixed $object, array $options } match (true) { - $object instanceof RouteCollection => $this->describeRouteCollection($object, $options), + $object instanceof RouteCollection => $this->describeRouteCollection($this->filterRoutesByHttpMethod($object, $options['method'] ?? ''), $options), $object instanceof Route => $this->describeRoute($object, $options), $object instanceof ParameterBag => $this->describeContainerParameters($object, $options), $object instanceof ContainerBuilder && !empty($options['env-vars']) => $this->describeContainerEnvVars($this->getContainerEnvVars($object), $options), @@ -360,4 +360,20 @@ protected function getServiceEdges(ContainerBuilder $container, string $serviceI return []; } } + + private function filterRoutesByHttpMethod(RouteCollection $routes, string $method): RouteCollection + { + if (!$method) { + return $routes; + } + $filteredRoutes = clone $routes; + + foreach ($filteredRoutes as $routeName => $route) { + if ($route->getMethods() && !\in_array($method, $route->getMethods(), true)) { + $filteredRoutes->remove($routeName); + } + } + + return $filteredRoutes; + } } diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTestCase.php index 477bd1014f2e5..eb18fbcc75b79 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTestCase.php +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTestCase.php @@ -50,6 +50,21 @@ public static function getDescribeRouteCollectionTestData(): array return static::getDescriptionTestData(ObjectsProvider::getRouteCollections()); } + /** @dataProvider getDescribeRouteCollectionWithHttpMethodFilterTestData */ + public function testDescribeRouteCollectionWithHttpMethodFilter(string $httpMethod, RouteCollection $routes, $expectedDescription) + { + $this->assertDescription($expectedDescription, $routes, ['method' => $httpMethod]); + } + + public static function getDescribeRouteCollectionWithHttpMethodFilterTestData(): iterable + { + foreach (ObjectsProvider::getRouteCollectionsByHttpMethod() as $httpMethod => $routeCollection) { + foreach (static::getDescriptionTestData($routeCollection) as $testData) { + yield [$httpMethod, ...$testData]; + } + } + } + /** @dataProvider getDescribeRouteTestData */ public function testDescribeRoute(Route $route, $expectedDescription) { @@ -273,6 +288,7 @@ private function assertDescription($expectedDescription, $describedObject, array $options['is_debug'] = false; $options['raw_output'] = true; $options['raw_text'] = true; + $options['method'] ??= null; $output = new BufferedOutput(BufferedOutput::VERBOSITY_NORMAL, true); if ('txt' === $this->getFormat()) { diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php index 84adc4ac9bc45..8eb1c438601c2 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php @@ -37,6 +37,38 @@ public static function getRouteCollections() return ['route_collection_1' => $collection1]; } + public static function getRouteCollectionsByHttpMethod(): array + { + $collection = new RouteCollection(); + foreach (self::getRoutes() as $name => $route) { + $collection->add($name, $route); + } + + // Clone the original collection and add a route without any specific method restrictions + $collectionWithRouteWithoutMethodRestriction = clone $collection; + $collectionWithRouteWithoutMethodRestriction->add( + 'route_3', + new RouteStub( + '/other/route', + [], + [], + ['opt1' => 'val1', 'opt2' => 'val2'], + 'localhost', + ['http', 'https'], + [], + ) + ); + + return [ + 'GET' => [ + 'route_collection_2' => $collectionWithRouteWithoutMethodRestriction, + ], + 'PUT' => [ + 'route_collection_3' => $collection, + ], + ]; + } + public static function getRoutes() { return [ diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.json b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.json new file mode 100644 index 0000000000000..8f5d2c743eb02 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.json @@ -0,0 +1,38 @@ +{ + "route_1": { + "path": "\/hello\/{name}", + "pathRegex": "#PATH_REGEX#", + "host": "localhost", + "hostRegex": "#HOST_REGEX#", + "scheme": "http|https", + "method": "GET|HEAD", + "class": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\RouteStub", + "defaults": { + "name": "Joseph" + }, + "requirements": { + "name": "[a-z]+" + }, + "options": { + "compiler_class": "Symfony\\Component\\Routing\\RouteCompiler", + "opt1": "val1", + "opt2": "val2" + } + }, + "route_3": { + "path": "\/other\/route", + "pathRegex": "#PATH_REGEX#", + "host": "localhost", + "hostRegex": "#HOST_REGEX#", + "scheme": "http|https", + "method": "ANY", + "class": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\RouteStub", + "defaults": [], + "requirements": "NO CUSTOM", + "options": { + "compiler_class": "Symfony\\Component\\Routing\\RouteCompiler", + "opt1": "val1", + "opt2": "val2" + } + } +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.md new file mode 100644 index 0000000000000..e1b11e4a499e2 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.md @@ -0,0 +1,37 @@ +route_1 +------- + +- Path: /hello/{name} +- Path Regex: #PATH_REGEX# +- Host: localhost +- Host Regex: #HOST_REGEX# +- Scheme: http|https +- Method: GET|HEAD +- Class: Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub +- Defaults: + - `name`: Joseph +- Requirements: + - `name`: [a-z]+ +- Options: + - `compiler_class`: Symfony\Component\Routing\RouteCompiler + - `opt1`: val1 + - `opt2`: val2 + + +route_3 +------- + +- Path: /other/route +- Path Regex: #PATH_REGEX# +- Host: localhost +- Host Regex: #HOST_REGEX# +- Scheme: http|https +- Method: ANY +- Class: Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub +- Defaults: NONE +- Requirements: NO CUSTOM +- Options: + - `compiler_class`: Symfony\Component\Routing\RouteCompiler + - `opt1`: val1 + - `opt2`: val2 + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.txt new file mode 100644 index 0000000000000..a9f9ee21b7497 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.txt @@ -0,0 +1,7 @@ + --------- ---------- ------------ ----------- --------------- +  Name   Method   Scheme   Host   Path  + --------- ---------- ------------ ----------- --------------- + route_1 GET|HEAD http|https localhost /hello/{name} + route_3 ANY http|https localhost /other/route + --------- ---------- ------------ ----------- --------------- + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.xml new file mode 100644 index 0000000000000..18c41deb79990 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.xml @@ -0,0 +1,33 @@ + + + + /hello/{name} + localhost + http + https + GET + HEAD + + Joseph + + + [a-z]+ + + + + + + + + + /other/route + localhost + http + https + + + + + + + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.json b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.json new file mode 100644 index 0000000000000..cabc8e0a71955 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.json @@ -0,0 +1,19 @@ +{ + "route_2": { + "path": "\/name\/add", + "pathRegex": "#PATH_REGEX#", + "host": "localhost", + "hostRegex": "#HOST_REGEX#", + "scheme": "http|https", + "method": "PUT|POST", + "class": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\RouteStub", + "defaults": [], + "requirements": "NO CUSTOM", + "options": { + "compiler_class": "Symfony\\Component\\Routing\\RouteCompiler", + "opt1": "val1", + "opt2": "val2" + }, + "condition": "context.getMethod() in ['GET', 'HEAD', 'POST']" + } +} diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.md new file mode 100644 index 0000000000000..20fdabb958098 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.md @@ -0,0 +1,18 @@ +route_2 +------- + +- Path: /name/add +- Path Regex: #PATH_REGEX# +- Host: localhost +- Host Regex: #HOST_REGEX# +- Scheme: http|https +- Method: PUT|POST +- Class: Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub +- Defaults: NONE +- Requirements: NO CUSTOM +- Options: + - `compiler_class`: Symfony\Component\Routing\RouteCompiler + - `opt1`: val1 + - `opt2`: val2 +- Condition: context.getMethod() in ['GET', 'HEAD', 'POST'] + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.txt new file mode 100644 index 0000000000000..8822b3c40793a --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.txt @@ -0,0 +1,6 @@ + --------- ---------- ------------ ----------- ----------- +  Name   Method   Scheme   Host   Path  + --------- ---------- ------------ ----------- ----------- + route_2 PUT|POST http|https localhost /name/add + --------- ---------- ------------ ----------- ----------- + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.xml new file mode 100644 index 0000000000000..57a05d4c10bd5 --- /dev/null +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.xml @@ -0,0 +1,17 @@ + + + + /name/add + localhost + http + https + PUT + POST + + + + + + context.getMethod() in ['GET', 'HEAD', 'POST'] + +