Skip to content

[FrameworkBundle] Only show relevant columns in debug:router call and adding colors #59780

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

Open
wants to merge 1 commit into
base: 7.4
Choose a base branch
from
+220 −30
Open

[FrameworkBundle] Only show relevant columns in debug:router call and adding colors #59780

Show file tree
Hide file tree
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
86 changes: 68 additions & 18 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,47 +38,82 @@
*/
class TextDescriptor extends Descriptor
{
private const VERB_COLORS = [
'ANY' => 'default',
'GET' => 'blue',
'HEAD' => 'magenta',
'OPTIONS' => 'blue',
'POST' => 'green',
'PUT' => 'yellow',
'PATCH' => 'yellow',
'DELETE' => 'red',
];

public function __construct(
private ?FileLinkFormatter $fileLinkFormatter = null,
) {
}

protected function describeRouteCollection(RouteCollection $routes, array $options = []): void
{
$showControllers = isset($options['show_controllers']) && $options['show_controllers'];

$tableHeaders = ['Name', 'Method', 'Scheme', 'Host', 'Path'];
if ($showControllers) {
$tableHeaders[] = 'Controller';
}

if ($showAliases = $options['show_aliases'] ?? false) {
$tableHeaders[] = 'Aliases';
}
$showAliases = $options['show_aliases'] ?? false;
$showControllers = $options['show_controllers'] ?? false;

$tableRows = [];
$shouldShowScheme = false;
$shouldShowHost = false;
foreach ($routes->all() as $name => $route) {
$controller = $route->getDefault('_controller');

$scheme = $route->getSchemes() ? implode('|', $route->getSchemes()) : 'ANY';
$shouldShowScheme = $shouldShowScheme || 'ANY' !== $scheme;

$host = '' !== $route->getHost() ? $route->getHost() : 'ANY';
$shouldShowHost = $shouldShowHost || 'ANY' !== $host;

$row = [
$name,
$route->getMethods() ? implode('|', $route->getMethods()) : 'ANY',
$route->getSchemes() ? implode('|', $route->getSchemes()) : 'ANY',
'' !== $route->getHost() ? $route->getHost() : 'ANY',
$this->formatControllerLink($controller, $route->getPath(), $options['container'] ?? null),
'Name' => $name,
'Methods' => $this->formatMethods($route->getMethods()),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no way to disable colors which is BC break if someone depends on the output, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, currently there is no BC layer planned. As discussed in the thread we don't expect anyone using this output for automation (like scripting) and only for visual output.

'Scheme' => $scheme,
'Host' => $host,
'Path' => $route->getPath(),
];

if ($showControllers) {
$row[] = $controller ? $this->formatControllerLink($controller, $this->formatCallable($controller), $options['container'] ?? null) : '';
$row['Controller'] = $controller ? $this->formatControllerLink($controller, $this->formatCallable($controller), $options['container'] ?? null) : '';
}

if ($showAliases) {
$row[] = implode('|', ($reverseAliases ??= $this->getReverseAliases($routes))[$name] ?? []);
$row['Aliases'] = implode('|', ($this->getReverseAliases($routes))[$name] ?? []);
}

$tableRows[] = $row;
}

$tableHeaders = ['Name', 'Method'];

if ($shouldShowScheme) {
$tableHeaders[] = 'Scheme';
} else {
array_walk($tableRows, function (&$row) { unset($row['Scheme']); });
}

if ($shouldShowHost) {
$tableHeaders[] = 'Host';
} else {
array_walk($tableRows, function (&$row) { unset($row['Host']); });
}

$tableHeaders[] = 'Path';

if ($showControllers) {
$tableHeaders[] = 'Controller';
}

if ($showAliases) {
$tableHeaders[] = 'Aliases';
}

if (isset($options['output'])) {
$options['output']->table($tableHeaders, $tableRows);
} else {
Expand All @@ -103,7 +138,7 @@ protected function describeRoute(Route $route, array $options = []): void
['Host', '' !== $route->getHost() ? $route->getHost() : 'ANY'],
['Host Regex', '' !== $route->getHost() ? $route->compile()->getHostRegex() : ''],
['Scheme', $route->getSchemes() ? implode('|', $route->getSchemes()) : 'ANY'],
['Method', $route->getMethods() ? implode('|', $route->getMethods()) : 'ANY'],
['Method', $this->formatMethods($route->getMethods())],
['Requirements', $route->getRequirements() ? $this->formatRouterConfig($route->getRequirements()) : 'NO CUSTOM'],
['Class', $route::class],
['Defaults', $this->formatRouterConfig($defaults)],
Expand Down Expand Up @@ -576,6 +611,21 @@ private function formatRouterConfig(array $config): string
return trim($configAsString);
}

/**
* @param array<string> $methods
*/
private function formatMethods(array $methods): string
{
if (count($methods) === 0) {
$methods = ['ANY'];
}

return implode('|', array_map(
fn (string $method): string => sprintf('<fg=%s>%s</>', self::VERB_COLORS[$method] ?? 'default', $method),
$methods
Comment on lines +619 to +625
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (count($methods) === 0) {
$methods = ['ANY'];
}
return implode('|', array_map(
fn (string $method): string => sprintf('<fg=%s>%s</>', self::VERB_COLORS[$method] ?? 'default', $method),
$methods
return implode('|', array_map(
fn (string $method): string => sprintf('<fg=%s>%s</>', self::VERB_COLORS[$method] ?? 'default', $method),
$methods ?: ['ANY']

));
}

/**
* @param (callable():ContainerBuilder)|null $getContainer
*/
Expand Down
27 changes: 26 additions & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,32 @@ public static function getRouteCollections()
$collection1->add($name, $route);
}

return ['route_collection_1' => $collection1];
$routesWithGenericHost = new RouteCollection();
$routesWithGenericHost->add('some_route', new RouteStub(
'/some-route',
['_controller' => 'Controller'],
[],
[],
null,
['https'],
));

$routesWithGenericScheme = new RouteCollection();
$routesWithGenericScheme->add('some_route_with_host', new RouteStub(
'/some-route',
['_controller' => 'strpos'],
[],
[],
'symfony.com',
[],
));

return [
'empty_route_collection' => new RouteCollection(),
'route_collection_1' => $collection1,
'route_with_generic_host' => $routesWithGenericHost,
'route_with_generic_scheme' => $routesWithGenericScheme,
];
}

public static function getRouteCollectionsByHttpMethod(): array
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/empty_route_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[]

Empty file added ...fony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/empty_route_collection.md
View file
Open in desktop
Empty file.
4 changes: 4 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/empty_route_collection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
------ -------- ------
 Name   Method   Path 
------ -------- ------

3 changes: 3 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/empty_route_collection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<?xml version="1.0" encoding="UTF-8"?>
<routes/>

2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Host | localhost |
| Host Regex | #HOST_REGEX# |
| Scheme | http|https |
| Method | GET|HEAD |
| Method | GET|HEAD |
| Requirements | name: [a-z]+ |
| Class | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub |
| Defaults | name: Joseph |
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_1_link.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Host | localhost |
| Host Regex | #HOST_REGEX# |
| Scheme | http|https |
| Method | GET|HEAD |
| Method | GET|HEAD |
| Requirements | name: [a-z]+ |
| Class | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub |
| Defaults | _controller: ]8;;myeditor://open?file=[:file:]&line=58\Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\MyController::__invoke()]8;;\ |
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Host | localhost |
| Host Regex | #HOST_REGEX# |
| Scheme | http|https |
| Method | PUT|POST |
| Method | PUT|POST |
| Requirements | NO CUSTOM |
| Class | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub |
| Defaults | NONE |
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2_link.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Host | localhost |
| Host Regex | #HOST_REGEX# |
| Scheme | http|https |
| Method | PUT|POST |
| Method | PUT|POST |
| Requirements | NO CUSTOM |
| Class | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub |
| Defaults | _controller: ]8;;myeditor://open?file=[:file:]&line=58\Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\MyController::__invoke()]8;;\ |
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@
"condition": "context.getMethod() in ['GET', 'HEAD', 'POST']"
}
}

3 changes: 1 addition & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,4 @@ route_2
- `compiler_class`: Symfony\Component\Routing\RouteCompiler
- `opt1`: val1
- `opt2`: val2
- Condition: context.getMethod() in ['GET', 'HEAD', 'POST']

- Condition: context.getMethod() in ['GET', 'HEAD', 'POST']
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
--------- ---------- ------------ ----------- ---------------
 Name   Method   Scheme   Host   Path 
--------- ---------- ------------ ----------- ---------------
route_1 GET|HEAD http|https localhost /hello/{name}
route_2 PUT|POST http|https localhost /name/add
route_1 GET|HEAD http|https localhost /hello/{name}
route_2 PUT|POST http|https localhost /name/add
--------- ---------- ------------ ----------- ---------------

1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@
<condition>context.getMethod() in ['GET', 'HEAD', 'POST']</condition>
</route>
</routes>

4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
--------- ---------- ------------ ----------- ---------------
 Name   Method   Scheme   Host   Path 
--------- ---------- ------------ ----------- ---------------
route_1 GET|HEAD http|https localhost /hello/{name}
route_3 ANY http|https localhost /other/route
route_1 GET|HEAD http|https localhost /hello/{name}
route_3 ANY http|https localhost /other/route
--------- ---------- ------------ ----------- ---------------

2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_3.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
--------- ---------- ------------ ----------- -----------
 Name   Method   Scheme   Host   Path 
--------- ---------- ------------ ----------- -----------
route_2 PUT|POST http|https localhost /name/add
route_2 PUT|POST http|https localhost /name/add
--------- ---------- ------------ ----------- -----------

18 changes: 18 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_host.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"some_route": {
"path": "\/some-route",
"pathRegex": "#PATH_REGEX#",
"host": "ANY",
"hostRegex": "",
"scheme": "https",
"method": "ANY",
"class": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\RouteStub",
"defaults": {
"_controller": "Controller"
},
"requirements": "NO CUSTOM",
"options": {
"compiler_class": "Symfony\\Component\\Routing\\RouteCompiler"
}
}
}
15 changes: 15 additions & 0 deletions ...ony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_host.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
some_route
----------

- Path: /some-route
- Path Regex: #PATH_REGEX#
- Host: ANY
- Host Regex:
- Scheme: https
- Method: ANY
- Class: Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub
- Defaults:
- `_controller`: Controller
- Requirements: NO CUSTOM
- Options:
- `compiler_class`: Symfony\Component\Routing\RouteCompiler
6 changes: 6 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_host.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
------------ -------- -------- -------------
 Name   Method   Scheme   Path 
------------ -------- -------- -------------
some_route ANY https /some-route
------------ -------- -------- -------------

14 changes: 14 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_host.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<routes>
<route name="some_route" class="Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub">
<path regex="#PATH_REGEX#">/some-route</path>
<scheme>https</scheme>
<defaults>
<default key="_controller">Controller</default>
</defaults>
<options>
<option key="compiler_class">Symfony\Component\Routing\RouteCompiler</option>
</options>
</route>
</routes>

18 changes: 18 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_scheme.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"some_route_with_host": {
"path": "\/some-route",
"pathRegex": "#PATH_REGEX#",
"host": "symfony.com",
"hostRegex": "#HOST_REGEX#",
"scheme": "ANY",
"method": "ANY",
"class": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\RouteStub",
"defaults": {
"_controller": "strpos"
},
"requirements": "NO CUSTOM",
"options": {
"compiler_class": "Symfony\\Component\\Routing\\RouteCompiler"
}
}
}
15 changes: 15 additions & 0 deletions ...y/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_scheme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
some_route_with_host
--------------------

- Path: /some-route
- Path Regex: #PATH_REGEX#
- Host: symfony.com
- Host Regex: #HOST_REGEX#
- Scheme: ANY
- Method: ANY
- Class: Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub
- Defaults:
- `_controller`: strpos
- Requirements: NO CUSTOM
- Options:
- `compiler_class`: Symfony\Component\Routing\RouteCompiler
6 changes: 6 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_scheme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---------------------- -------- ------------- -------------
 Name   Method   Host   Path 
---------------------- -------- ------------- -------------
some_route_with_host ANY symfony.com /some-route
---------------------- -------- ------------- -------------

13 changes: 13 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_with_generic_scheme.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<routes>
<route name="some_route_with_host" class="Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\RouteStub">
<path regex="#PATH_REGEX#">/some-route</path>
<host regex="#HOST_REGEX#">symfony.com</host>
<defaults>
<default key="_controller">strpos</default>
</defaults>
<options>
<option key="compiler_class">Symfony\Component\Routing\RouteCompiler</option>
</options>
</route>
</routes>
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy