[DI] Remove AutowireExceptionPass
This commit is contained in:
parent
f2594d246b
commit
2ada55878a
@ -22,6 +22,7 @@ CHANGELOG
|
|||||||
* removed support for setting and accessing private services in `Container`
|
* removed support for setting and accessing private services in `Container`
|
||||||
* removed support for setting pre-defined services in `Container`
|
* removed support for setting pre-defined services in `Container`
|
||||||
* removed support for case insensitivity of parameter names
|
* removed support for case insensitivity of parameter names
|
||||||
|
* removed `AutowireExceptionPass` and `AutowirePass::getAutowiringExceptions()`, use `Definition::addError()` and the `DefinitionErrorExceptionPass` instead
|
||||||
|
|
||||||
3.4.0
|
3.4.0
|
||||||
-----
|
-----
|
||||||
|
@ -1,74 +0,0 @@
|
|||||||
<?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\Component\DependencyInjection\Compiler;
|
|
||||||
|
|
||||||
@trigger_error('The '.__NAMESPACE__.'\AutowireExceptionPass class is deprecated since version 3.4 and will be removed in 4.0. Use the DefinitionErrorExceptionPass class instead.', E_USER_DEPRECATED);
|
|
||||||
|
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Throws autowire exceptions from AutowirePass for definitions that still exist.
|
|
||||||
*
|
|
||||||
* @deprecated since version 3.4, will be removed in 4.0.
|
|
||||||
*
|
|
||||||
* @author Ryan Weaver <ryan@knpuniversity.com>
|
|
||||||
*/
|
|
||||||
class AutowireExceptionPass implements CompilerPassInterface
|
|
||||||
{
|
|
||||||
private $autowirePass;
|
|
||||||
private $inlineServicePass;
|
|
||||||
|
|
||||||
public function __construct(AutowirePass $autowirePass, InlineServiceDefinitionsPass $inlineServicePass)
|
|
||||||
{
|
|
||||||
$this->autowirePass = $autowirePass;
|
|
||||||
$this->inlineServicePass = $inlineServicePass;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function process(ContainerBuilder $container)
|
|
||||||
{
|
|
||||||
// the pass should only be run once
|
|
||||||
if (null === $this->autowirePass || null === $this->inlineServicePass) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$inlinedIds = $this->inlineServicePass->getInlinedServiceIds();
|
|
||||||
$exceptions = $this->autowirePass->getAutowiringExceptions();
|
|
||||||
|
|
||||||
// free up references
|
|
||||||
$this->autowirePass = null;
|
|
||||||
$this->inlineServicePass = null;
|
|
||||||
|
|
||||||
foreach ($exceptions as $exception) {
|
|
||||||
if ($this->doesServiceExistInTheContainer($exception->getServiceId(), $container, $inlinedIds)) {
|
|
||||||
throw $exception;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private function doesServiceExistInTheContainer($serviceId, ContainerBuilder $container, array $inlinedIds)
|
|
||||||
{
|
|
||||||
if ($container->hasDefinition($serviceId)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// was the service inlined? Of so, does its parent service exist?
|
|
||||||
if (isset($inlinedIds[$serviceId])) {
|
|
||||||
foreach ($inlinedIds[$serviceId] as $parentId) {
|
|
||||||
if ($this->doesServiceExistInTheContainer($parentId, $container, $inlinedIds)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
@ -31,7 +31,6 @@ class AutowirePass extends AbstractRecursivePass
|
|||||||
private $autowired = array();
|
private $autowired = array();
|
||||||
private $lastFailure;
|
private $lastFailure;
|
||||||
private $throwOnAutowiringException;
|
private $throwOnAutowiringException;
|
||||||
private $autowiringExceptions = array();
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param bool $throwOnAutowireException Errors can be retrieved via Definition::getErrors()
|
* @param bool $throwOnAutowireException Errors can be retrieved via Definition::getErrors()
|
||||||
@ -41,26 +40,11 @@ class AutowirePass extends AbstractRecursivePass
|
|||||||
$this->throwOnAutowiringException = $throwOnAutowireException;
|
$this->throwOnAutowiringException = $throwOnAutowireException;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @deprecated since version 3.4, to be removed in 4.0.
|
|
||||||
*
|
|
||||||
* @return AutowiringFailedException[]
|
|
||||||
*/
|
|
||||||
public function getAutowiringExceptions()
|
|
||||||
{
|
|
||||||
@trigger_error('Calling AutowirePass::getAutowiringExceptions() is deprecated since Symfony 3.4 and will be removed in 4.0. Use Definition::getErrors() instead.', E_USER_DEPRECATED);
|
|
||||||
|
|
||||||
return $this->autowiringExceptions;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritdoc}
|
* {@inheritdoc}
|
||||||
*/
|
*/
|
||||||
public function process(ContainerBuilder $container)
|
public function process(ContainerBuilder $container)
|
||||||
{
|
{
|
||||||
// clear out any possibly stored exceptions from before
|
|
||||||
$this->autowiringExceptions = array();
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
parent::process($container);
|
parent::process($container);
|
||||||
} finally {
|
} finally {
|
||||||
@ -82,7 +66,6 @@ class AutowirePass extends AbstractRecursivePass
|
|||||||
throw $e;
|
throw $e;
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->autowiringExceptions[] = $e;
|
|
||||||
$this->container->getDefinition($this->currentId)->addError($e->getMessage());
|
$this->container->getDefinition($this->currentId)->addError($e->getMessage());
|
||||||
|
|
||||||
return parent::processValue($value, $isRoot);
|
return parent::processValue($value, $isRoot);
|
||||||
|
@ -23,7 +23,6 @@ use Symfony\Component\DependencyInjection\Reference;
|
|||||||
class InlineServiceDefinitionsPass extends AbstractRecursivePass implements RepeatablePassInterface
|
class InlineServiceDefinitionsPass extends AbstractRecursivePass implements RepeatablePassInterface
|
||||||
{
|
{
|
||||||
private $repeatedPass;
|
private $repeatedPass;
|
||||||
private $inlinedServiceIds = array();
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritdoc}
|
* {@inheritdoc}
|
||||||
@ -33,22 +32,6 @@ class InlineServiceDefinitionsPass extends AbstractRecursivePass implements Repe
|
|||||||
$this->repeatedPass = $repeatedPass;
|
$this->repeatedPass = $repeatedPass;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns an array of all services inlined by this pass.
|
|
||||||
*
|
|
||||||
* The key is the inlined service id and its value is the list of services it was inlined into.
|
|
||||||
*
|
|
||||||
* @deprecated since version 3.4, to be removed in 4.0.
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function getInlinedServiceIds()
|
|
||||||
{
|
|
||||||
@trigger_error('Calling InlineServiceDefinitionsPass::getInlinedServiceIds() is deprecated since Symfony 3.4 and will be removed in 4.0.', E_USER_DEPRECATED);
|
|
||||||
|
|
||||||
return $this->inlinedServiceIds;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritdoc}
|
* {@inheritdoc}
|
||||||
*/
|
*/
|
||||||
@ -63,7 +46,6 @@ class InlineServiceDefinitionsPass extends AbstractRecursivePass implements Repe
|
|||||||
|
|
||||||
if ($this->isInlineableDefinition($id, $definition, $this->container->getCompiler()->getServiceReferenceGraph())) {
|
if ($this->isInlineableDefinition($id, $definition, $this->container->getCompiler()->getServiceReferenceGraph())) {
|
||||||
$this->container->log($this, sprintf('Inlined service "%s" to "%s".', $id, $this->currentId));
|
$this->container->log($this, sprintf('Inlined service "%s" to "%s".', $id, $this->currentId));
|
||||||
$this->inlinedServiceIds[$id][] = $this->currentId;
|
|
||||||
|
|
||||||
if ($definition->isShared()) {
|
if ($definition->isShared()) {
|
||||||
return $definition;
|
return $definition;
|
||||||
|
@ -1,145 +0,0 @@
|
|||||||
<?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\Component\DependencyInjection\Tests\Compiler;
|
|
||||||
|
|
||||||
use PHPUnit\Framework\TestCase;
|
|
||||||
use Symfony\Component\DependencyInjection\Compiler\AutowireExceptionPass;
|
|
||||||
use Symfony\Component\DependencyInjection\Compiler\AutowirePass;
|
|
||||||
use Symfony\Component\DependencyInjection\Compiler\InlineServiceDefinitionsPass;
|
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
||||||
use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @group legacy
|
|
||||||
*/
|
|
||||||
class AutowireExceptionPassTest extends TestCase
|
|
||||||
{
|
|
||||||
public function testThrowsException()
|
|
||||||
{
|
|
||||||
$autowirePass = $this->getMockBuilder(AutowirePass::class)
|
|
||||||
->getMock();
|
|
||||||
|
|
||||||
$autowireException = new AutowiringFailedException('foo_service_id', 'An autowiring exception message');
|
|
||||||
$autowirePass->expects($this->any())
|
|
||||||
->method('getAutowiringExceptions')
|
|
||||||
->will($this->returnValue(array($autowireException)));
|
|
||||||
|
|
||||||
$inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
|
|
||||||
->getMock();
|
|
||||||
$inlinePass->expects($this->any())
|
|
||||||
->method('getInlinedServiceIds')
|
|
||||||
->will($this->returnValue(array()));
|
|
||||||
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
$container->register('foo_service_id');
|
|
||||||
|
|
||||||
$pass = new AutowireExceptionPass($autowirePass, $inlinePass);
|
|
||||||
|
|
||||||
try {
|
|
||||||
$pass->process($container);
|
|
||||||
$this->fail('->process() should throw the exception if the service id exists');
|
|
||||||
} catch (\Exception $e) {
|
|
||||||
$this->assertSame($autowireException, $e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testThrowExceptionIfServiceInlined()
|
|
||||||
{
|
|
||||||
$autowirePass = $this->getMockBuilder(AutowirePass::class)
|
|
||||||
->getMock();
|
|
||||||
|
|
||||||
$autowireException = new AutowiringFailedException('a_service', 'An autowiring exception message');
|
|
||||||
$autowirePass->expects($this->any())
|
|
||||||
->method('getAutowiringExceptions')
|
|
||||||
->will($this->returnValue(array($autowireException)));
|
|
||||||
|
|
||||||
$inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
|
|
||||||
->getMock();
|
|
||||||
$inlinePass->expects($this->any())
|
|
||||||
->method('getInlinedServiceIds')
|
|
||||||
->will($this->returnValue(array(
|
|
||||||
// a_service inlined into b_service
|
|
||||||
'a_service' => array('b_service'),
|
|
||||||
// b_service inlined into c_service
|
|
||||||
'b_service' => array('c_service'),
|
|
||||||
)));
|
|
||||||
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
// ONLY register c_service in the final container
|
|
||||||
$container->register('c_service', 'stdClass');
|
|
||||||
|
|
||||||
$pass = new AutowireExceptionPass($autowirePass, $inlinePass);
|
|
||||||
|
|
||||||
try {
|
|
||||||
$pass->process($container);
|
|
||||||
$this->fail('->process() should throw the exception if the service id exists');
|
|
||||||
} catch (\Exception $e) {
|
|
||||||
$this->assertSame($autowireException, $e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testDoNotThrowExceptionIfServiceInlinedButRemoved()
|
|
||||||
{
|
|
||||||
$autowirePass = $this->getMockBuilder(AutowirePass::class)
|
|
||||||
->getMock();
|
|
||||||
|
|
||||||
$autowireException = new AutowiringFailedException('a_service', 'An autowiring exception message');
|
|
||||||
$autowirePass->expects($this->any())
|
|
||||||
->method('getAutowiringExceptions')
|
|
||||||
->will($this->returnValue(array($autowireException)));
|
|
||||||
|
|
||||||
$inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
|
|
||||||
->getMock();
|
|
||||||
$inlinePass->expects($this->any())
|
|
||||||
->method('getInlinedServiceIds')
|
|
||||||
->will($this->returnValue(array(
|
|
||||||
// a_service inlined into b_service
|
|
||||||
'a_service' => array('b_service'),
|
|
||||||
// b_service inlined into c_service
|
|
||||||
'b_service' => array('c_service'),
|
|
||||||
)));
|
|
||||||
|
|
||||||
// do NOT register c_service in the container
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
|
|
||||||
$pass = new AutowireExceptionPass($autowirePass, $inlinePass);
|
|
||||||
|
|
||||||
$pass->process($container);
|
|
||||||
// mark the test as passed
|
|
||||||
$this->assertTrue(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testNoExceptionIfServiceRemoved()
|
|
||||||
{
|
|
||||||
$autowirePass = $this->getMockBuilder(AutowirePass::class)
|
|
||||||
->getMock();
|
|
||||||
|
|
||||||
$autowireException = new AutowiringFailedException('non_existent_service');
|
|
||||||
$autowirePass->expects($this->any())
|
|
||||||
->method('getAutowiringExceptions')
|
|
||||||
->will($this->returnValue(array($autowireException)));
|
|
||||||
|
|
||||||
$inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
|
|
||||||
->getMock();
|
|
||||||
$inlinePass->expects($this->any())
|
|
||||||
->method('getInlinedServiceIds')
|
|
||||||
->will($this->returnValue(array()));
|
|
||||||
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
|
|
||||||
$pass = new AutowireExceptionPass($autowirePass, $inlinePass);
|
|
||||||
|
|
||||||
$pass->process($container);
|
|
||||||
// mark the test as passed
|
|
||||||
$this->assertTrue(true);
|
|
||||||
}
|
|
||||||
}
|
|
@ -131,24 +131,6 @@ class AutowirePassTest extends TestCase
|
|||||||
$this->assertEquals(DInterface::class, (string) $container->getDefinition('h')->getArgument(1));
|
$this->assertEquals(DInterface::class, (string) $container->getDefinition('h')->getArgument(1));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @group legacy
|
|
||||||
*/
|
|
||||||
public function testExceptionsAreStored()
|
|
||||||
{
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
|
|
||||||
$container->register('c1', __NAMESPACE__.'\CollisionA');
|
|
||||||
$container->register('c2', __NAMESPACE__.'\CollisionB');
|
|
||||||
$container->register('c3', __NAMESPACE__.'\CollisionB');
|
|
||||||
$aDefinition = $container->register('a', __NAMESPACE__.'\CannotBeAutowired');
|
|
||||||
$aDefinition->setAutowired(true);
|
|
||||||
|
|
||||||
$pass = new AutowirePass(false);
|
|
||||||
$pass->process($container);
|
|
||||||
$this->assertCount(1, $pass->getAutowiringExceptions());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @expectedException \Symfony\Component\DependencyInjection\Exception\AutowiringFailedException
|
* @expectedException \Symfony\Component\DependencyInjection\Exception\AutowiringFailedException
|
||||||
* @expectedExceptionMessage Invalid service "private_service": constructor of class "Symfony\Component\DependencyInjection\Tests\Compiler\PrivateConstructor" must be public.
|
* @expectedExceptionMessage Invalid service "private_service": constructor of class "Symfony\Component\DependencyInjection\Tests\Compiler\PrivateConstructor" must be public.
|
||||||
|
@ -252,33 +252,6 @@ class InlineServiceDefinitionsPassTest extends TestCase
|
|||||||
$this->assertSame('inline', (string) $values[0]);
|
$this->assertSame('inline', (string) $values[0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @group legacy
|
|
||||||
*/
|
|
||||||
public function testGetInlinedServiceIdData()
|
|
||||||
{
|
|
||||||
$container = new ContainerBuilder();
|
|
||||||
$container
|
|
||||||
->register('inlinable.service')
|
|
||||||
->setPublic(false)
|
|
||||||
;
|
|
||||||
$container
|
|
||||||
->register('non_inlinable.service')
|
|
||||||
->setPublic(true)
|
|
||||||
;
|
|
||||||
|
|
||||||
$container
|
|
||||||
->register('other_service')
|
|
||||||
->setArguments(array(new Reference('inlinable.service')))
|
|
||||||
;
|
|
||||||
|
|
||||||
$inlinePass = new InlineServiceDefinitionsPass();
|
|
||||||
$repeatedPass = new RepeatedPass(array(new AnalyzeServiceReferencesPass(), $inlinePass));
|
|
||||||
$repeatedPass->process($container);
|
|
||||||
|
|
||||||
$this->assertEquals(array('inlinable.service' => array('other_service')), $inlinePass->getInlinedServiceIds());
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function process(ContainerBuilder $container)
|
protected function process(ContainerBuilder $container)
|
||||||
{
|
{
|
||||||
$repeatedPass = new RepeatedPass(array(new AnalyzeServiceReferencesPass(), new InlineServiceDefinitionsPass()));
|
$repeatedPass = new RepeatedPass(array(new AnalyzeServiceReferencesPass(), new InlineServiceDefinitionsPass()));
|
||||||
|
Reference in New Issue
Block a user