diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #12584 [RFC] [DebugBundle] [HttpKernel] Avoid using container as dependency for DumpListener (jeromemacias)

Browse Source 
This PR was squashed before being merged into the 2.6 branch (closes #12584).

Discussion
----------

[RFC] [DebugBundle] [HttpKernel] Avoid using container as dependency for DumpListener

| Q             | A
| ------------- | ---
| Bug fix?      | kinda
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

Usage of the `container` service as dependency avoid using the listener outside of a Symfony project.

I don't know if the lazy loading of the dumper service is really required. We should only use the `DebugBundle` in `dev` environment.
If it break performance, maybe we can consider using the `lazy="true"` parameter in services definition.

I currently working on a Silex [`DebugServiceProvider`](https://github.com/jeromemacias/Silex-Debug) which use the `DebugBundle` to avoid duplicating the dump profiler view (like it's done by the `WebProfilerServiceProvider`).
Those modifications are required by the provider to be usable.

Commits
-------

680fe7a [RFC] [DebugBundle] [HttpKernel] Avoid using container as dependency for DumpListener
This commit is contained in:
Nicolas Grekas 2014-11-27 17:54:54 +01:00
commit f8b1e68f1e
3 changed files with 28 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Symfony/Bundle/DebugBundle/Resources/config/services.xml
View File

@ -18,8 +18,8 @@
<service id="debug.dump_listener" class="Symfony\Component\HttpKernel\EventListener\DumpListener">
<tag name="kernel.event_subscriber" />
<argument type="service" id="service_container" />
<argument>data_collector.dump</argument>
<argument type="service" id="var_dumper.cloner" />
<argument type="service" id="data_collector.dump" />
</service>
<service id="var_dumper.cloner" class="Symfony\Component\VarDumper\Cloner\VarCloner" />

28
src/Symfony/Component/HttpKernel/EventListener/DumpListener.php
View File

@ -11,9 +11,10 @@
namespace Symfony\Component\HttpKernel\EventListener;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\VarDumper\Cloner\ClonerInterface;
use Symfony\Component\VarDumper\Dumper\DataDumperInterface;
use Symfony\Component\VarDumper\VarDumper;
/**
@ -27,30 +28,23 @@ class DumpListener implements EventSubscriberInterface
private $dumper;
/**
* @param ContainerInterface $container Service container, for lazy loading.
* @param string $dumper var_dumper dumper service to use.
* @param ClonerInterface $cloner Cloner service.
* @param DataDumperInterface $dumper Dumper service.
*/
public function __construct(ContainerInterface $container, $dumper)
public function __construct(ClonerInterface $cloner, DataDumperInterface $dumper)
{
$this->container = $container;
$this->cloner = $cloner;
$this->dumper = $dumper;
}
public function configure()
{
if ($this->container) {
$container = $this->container;
$dumper = $this->dumper;
$this->container = null;
$cloner = $this->cloner;
$dumper = $this->dumper;
VarDumper::setHandler(function ($var) use ($container, $dumper) {
$dumper = $container->get($dumper);
$cloner = $container->get('var_dumper.cloner');
$handler = function ($var) use ($dumper, $cloner) {$dumper->dump($cloner->cloneVar($var));};
VarDumper::setHandler($handler);
$handler($var);
});
}
VarDumper::setHandler(function ($var) use ($cloner, $dumper) {
$dumper->dump($cloner->cloneVar($var));
});
}
public static function getSubscribedEvents()

46
src/Symfony/Component/HttpKernel/Tests/EventListener/DumpListenerTest.php
View File

@ -11,10 +11,11 @@
namespace Symfony\Component\HttpKernel\Tests\EventListener;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\HttpKernel\EventListener\DumpListener;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\VarDumper\Cloner\ClonerInterface;
use Symfony\Component\VarDumper\Cloner\Data;
use Symfony\Component\VarDumper\Dumper\DataDumperInterface;
use Symfony\Component\VarDumper\VarDumper;
/**
@ -34,34 +35,23 @@ class DumpListenerTest extends \PHPUnit_Framework_TestCase
public function testConfigure()
{
$prevDumper = $this->getDumpHandler();
$prevDumper = VarDumper::setHandler('var_dump');
VarDumper::setHandler($prevDumper);
$container = new ContainerBuilder();
$container->setDefinition('var_dumper.cloner', new Definition('Symfony\Component\HttpKernel\Tests\EventListener\MockCloner'));
$container->setDefinition('mock_dumper', new Definition('Symfony\Component\HttpKernel\Tests\EventListener\MockDumper'));
$cloner = new MockCloner();
$dumper = new MockDumper();
ob_start();
$exception = null;
$listener = new DumpListener($container, 'mock_dumper');
$listener = new DumpListener($cloner, $dumper);
try {
$listener->configure();
$lazyDumper = $this->getDumpHandler();
VarDumper::dump('foo');
$loadedDumper = $this->getDumpHandler();
VarDumper::dump('bar');
$this->assertSame('+foo-+bar-', ob_get_clean());
$listenerReflector = new \ReflectionClass($listener);
$lazyReflector = new \ReflectionFunction($lazyDumper);
$loadedReflector = new \ReflectionFunction($loadedDumper);
$this->assertSame($listenerReflector->getFilename(), $lazyReflector->getFilename());
$this->assertSame($listenerReflector->getFilename(), $loadedReflector->getFilename());
$this->assertGreaterThan($lazyReflector->getStartLine(), $loadedReflector->getStartLine());
} catch (\Exception $exception) {
}
@ -71,28 +61,22 @@ class DumpListenerTest extends \PHPUnit_Framework_TestCase
throw $exception;
}
}
private function getDumpHandler()
{
$prevDumper = VarDumper::setHandler('var_dump');
VarDumper::setHandler($prevDumper );
return $prevDumper;
}
}
class MockCloner
class MockCloner implements ClonerInterface
{
public function cloneVar($var)
{
return $var.'-';
return new Data(array($var.'-'));
}
}
class MockDumper
class MockDumper implements DataDumperInterface
{
public function dump($var)
public function dump(Data $data)
{
echo '+'.$var;
$rawData = $data->getRawData();
echo '+'.$rawData[0];
}
}