Skip to content

[WIP][FrameworkBundle] Add debug autoconfigure command #28730

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ CHANGELOG
* Deprecated `CachePoolClearerPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolClearerPass` instead.
* Deprecated `CachePoolPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolPass` instead.
* Deprecated `CachePoolPrunerPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolPrunerPass` instead.
* Added `debug:autoconfiguration` command to display the autoconfiguration of interfaces/classes

4.1.0
-----
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Bundle\FrameworkBundle\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Dumper\YamlDumper;
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;

/**
* A console command for autoconfiguration information.
*
* @internal
*/
class DebugAutoconfigurationCommand extends Command
{
protected static $defaultName = 'debug:autoconfiguration';

/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->setDefinition(array(
new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
new InputOption('tags', null, InputOption::VALUE_NONE, 'Displays autoconfiguration interfaces/class grouped by tags'),
))
->setDescription('Displays current autoconfiguration for an application')
->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays all services that
are autoconfigured:

<info>php %command.full_name%</info>

You can also pass a search term to filter the list:

<info>php %command.full_name% log</info>

EOF
)
;
}

/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$io = new SymfonyStyle($input, $output);
$errorIo = $io->getErrorStyle();

$autoconfiguredInstanceofItems = $this->getContainerBuilder()->getAutoconfiguredInstanceof();

if ($search = $input->getArgument('search')) {
$autoconfiguredInstanceofItems = array_filter($autoconfiguredInstanceofItems, function ($key) use ($search) {
return false !== stripos(str_replace('\\', '', $key), $search);
}, ARRAY_FILTER_USE_KEY);

if (empty($autoconfiguredInstanceofItems)) {
$errorIo->error(sprintf('No autoconfiguration interface/class found matching "%s"', $search));

return 1;
}
}

ksort($autoconfiguredInstanceofItems, SORT_NATURAL);

$io->title('Autoconfiguration');
if ($search) {
$io->text(sprintf('(only showing classes/interfaces matching <comment>%s</comment>)', $search));
}
$io->newLine();

/** @var ChildDefinition $autoconfiguredInstanceofItem */
foreach ($autoconfiguredInstanceofItems as $key => $autoconfiguredInstanceofItem) {
$tableRows = array();
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we can get rid of the $tableRows array by using addRow() and render(), as this is for master. IMO its more readable afterwards

docs: https://symfony.com/doc/current/components/console/helpers/table.html#modifying-rendered-tables

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure it's more readable. To have the same style that the others commands, it is necessary to configure the table.

diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutoconfigurationCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutoconfigurationCommand.php
index bffdd32751..6d80649634 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutoconfigurationCommand.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutoconfigurationCommand.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
Stash this hunk [y,n,q,a,d,j,J,g,/,e,?]? y
@@ -91,26 +92,30 @@ EOF
 
         /** @var ChildDefinition $autoconfiguredInstanceofItem */
         foreach ($autoconfiguredInstanceofItems as $key => $autoconfiguredInstanceofItem) {
-            $tableRows = array();
+            $section = $output->section();
+            $table = new Table($section);
+            $table->setStyle(Table::getStyleDefinition('symfony-style-guide'));
+            $table->addRow(array('Option', 'Value'));
 
             foreach ($autoconfiguredInstanceofItem->getTags() as $tag => $tagAttributes) {
-                $tableRows[] = array('Tag', $tag);
+                $table->addRow(array('Tag', $tag));
                 if ($tagAttributes !== array(array())) {
-                    $tableRows[] = array('Tag attribute', $this->dumpTagAttribute($tagAttributes));
+                    $table->addRow(array('Tag attribute', $this->dumpTagAttribute($tagAttributes)));
                 }
             }
 
             if ($autoconfiguredInstanceofItem->getMethodCalls()) {
-                $tableRows[] = array('Method call', $this->dumpMethodCall($autoconfiguredInstanceofItem));
+                $table->addRow(array('Method call', $this->dumpMethodCall($autoconfiguredInstanceofItem)));
             }
 
             if ($autoconfiguredInstanceofItem->getBindings()) {
-                $tableRows[] = array('Bindings', $this->dumpBindings($autoconfiguredInstanceofItem));
+                $table->addRow(array('Bindings', $this->dumpBindings($autoconfiguredInstanceofItem)));
             }
 
             $io->writeln(sprintf("Autoconfiguration for \"%s\"\n==============================================", $key));
             $io->newLine();
-            $io->table(array('Option', 'Value'), $tableRows);
+            $table->render();
+            $io->newLine();
         }
     }


foreach ($autoconfiguredInstanceofItem->getTags() as $tag => $tagAttributes) {
$tableRows[] = array('Tag', $tag);
if ($tagAttributes !== array(array())) {
$tableRows[] = array('Tag attribute', $this->dumpTagAttribute($tagAttributes));
}
}

if ($autoconfiguredInstanceofItem->getMethodCalls()) {
$tableRows[] = array('Method call', $this->dumpMethodCall($autoconfiguredInstanceofItem));
}

if ($autoconfiguredInstanceofItem->getBindings()) {
$tableRows[] = array('Bindings', $this->dumpBindings($autoconfiguredInstanceofItem));
}

$io->writeln(sprintf("Autoconfiguration for \"%s\"\n==============================================", $key));
$io->newLine();
$io->table(array('Option', 'Value'), $tableRows);
}
}

private function dumpMethodCall(ChildDefinition $autoconfiguredInstanceofItem)
{
$tagContainerBuilder = new ContainerBuilder();
foreach ($tagContainerBuilder->getServiceIds() as $serviceId) {
$tagContainerBuilder->removeDefinition($serviceId);
$tagContainerBuilder->removeAlias($serviceId);
}
$tagContainerBuilder->addDefinitions(array($autoconfiguredInstanceofItem));

$dumper = new YamlDumper($tagContainerBuilder);
preg_match('/calls\:\n((?: +- .+\n)+)/', $dumper->dump(), $matches);

return preg_replace('/^\s+/m', '', $matches[1]);
}

private function dumpBindings(ChildDefinition $autoconfiguredInstanceofItem)
{
$tagContainerBuilder = new ContainerBuilder();
foreach ($tagContainerBuilder->getServiceIds() as $serviceId) {
$tagContainerBuilder->removeDefinition($serviceId);
$tagContainerBuilder->removeAlias($serviceId);
}

$dumper = new YamlDumper($tagContainerBuilder);
foreach ($autoconfiguredInstanceofItem->getBindings() as $bindingKey => $bindingValue) {
$tagContainerBuilder->setParameter($bindingKey, $bindingValue->getValues()[0]);
}

preg_match('/parameters\:\n((?: + .+\n)+)/', $dumper->dump(), $matches);

return preg_replace('/^\s+/m', '', $matches[1]);
}

private function dumpTagAttribute(array $tagAttribute)
{
$cloner = new VarCloner();
$cliDumper = new CliDumper(null, null, AbstractDumper::DUMP_LIGHT_ARRAY);

return $cliDumper->dump($cloner->cloneVar(current($tagAttribute)), true);
}

/**
* @return ContainerBuilder
*/
private function getContainerBuilder()
{
$kernel = $this->getApplication()->getKernel();
$buildContainer = \Closure::bind(function () { return $this->buildContainer(); }, $kernel, \get_class($kernel));
$container = $buildContainer();
$container->getCompilerPassConfig()->setRemovingPasses(array());
$container->compile();

return $container;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,9 @@ public function load(array $configs, ContainerBuilder $container)
$container->registerForAutoconfiguration(EventSubscriberInterface::class)
->addTag('kernel.event_subscriber');
$container->registerForAutoconfiguration(ResetInterface::class)
->addTag('kernel.reset', array('method' => 'reset'));
->addTag('kernel.reset', array('method' => 'reset'))
->addTag('kernel.reset2', array('method' => 'reset2'))
;

if (!interface_exists(MarshallerInterface::class)) {
$container->registerForAutoconfiguration(ResettableInterface::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@
<tag name="console.command" command="debug:container" />
</service>

<service id="console.command.debug_autoconfiguration" class="Symfony\Bundle\FrameworkBundle\Command\DebugAutoconfigurationCommand">
<tag name="console.command" command="debug:autoconfiguration" />
</service>

<service id="console.command.debug_autowiring" class="Symfony\Bundle\FrameworkBundle\Command\DebugAutowiringCommand">
<tag name="console.command" command="debug:autowiring" />
</service>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration;

class Bindings
{
private $paramOne;
private $paramTwo;

public function __construct($paramOne, $paramTwo)
{
$this->paramOne = $paramOne;
$this->paramTwo = $paramTwo;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration;

class MethodCalls
{
public function setMethodCallOne()
{
}

public function setMethodCallTwo()
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration;

class TagsAttributes
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe, I can use the TestBundle instead of create a new bundle ?


use Symfony\Component\HttpKernel\Bundle\Bundle;

class DebugAutoconfigurationBundle extends Bundle
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\DependencyInjection;

use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration\Bindings;
use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration\MethodCalls;
use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\DebugAutoconfigurationBundle\Autoconfiguration\TagsAttributes;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Reference;

class DebugAutoconfigurationExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container)
{
$container->registerForAutoconfiguration(MethodCalls::class)
->addMethodCall('setMethodOne', array(new Reference('logger')))
->addMethodCall('setMethodTwo', array(array('paramOne', 'paramOne')));

$container->registerForAutoconfiguration(Bindings::class)
->setBindings(array(
'$paramOne' => new Reference('logger'),
'$paramTwo' => 'binding test',
));

$container->registerForAutoconfiguration(TagsAttributes::class)
->addTag('debugautoconfiguration.tag1', array('method' => 'debug'))
->addTag('debugautoconfiguration.tag2', array('test'))
;
}
}
Loading