[DI] ignore extra tags added by autoconfiguration in PriorityTaggedServiceTrait
This commit is contained in:
parent
d246e941ab
commit
09770aa930
@ -15,7 +15,6 @@ use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
|
|||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
||||||
use Symfony\Component\DependencyInjection\Reference;
|
use Symfony\Component\DependencyInjection\Reference;
|
||||||
use Symfony\Component\DependencyInjection\TypedReference;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Trait that allows a generic method to find and sort service by priority option in the tag.
|
* Trait that allows a generic method to find and sort service by priority option in the tag.
|
||||||
@ -50,11 +49,10 @@ trait PriorityTaggedServiceTrait
|
|||||||
$tagName = $tagName->getTag();
|
$tagName = $tagName->getTag();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$i = 0;
|
||||||
$services = [];
|
$services = [];
|
||||||
|
|
||||||
foreach ($container->findTaggedServiceIds($tagName, true) as $serviceId => $attributes) {
|
foreach ($container->findTaggedServiceIds($tagName, true) as $serviceId => $attributes) {
|
||||||
$class = $r = null;
|
|
||||||
|
|
||||||
$defaultPriority = null;
|
$defaultPriority = null;
|
||||||
$defaultIndex = null;
|
$defaultIndex = null;
|
||||||
|
|
||||||
@ -64,78 +62,101 @@ trait PriorityTaggedServiceTrait
|
|||||||
if (isset($attribute['priority'])) {
|
if (isset($attribute['priority'])) {
|
||||||
$priority = $attribute['priority'];
|
$priority = $attribute['priority'];
|
||||||
} elseif (null === $defaultPriority && $defaultPriorityMethod) {
|
} elseif (null === $defaultPriority && $defaultPriorityMethod) {
|
||||||
$class = $container->getDefinition($serviceId)->getClass();
|
$defaultPriority = PriorityTaggedServiceUtil::getDefaultPriority($container, $serviceId, $defaultPriorityMethod, $tagName);
|
||||||
$class = $container->getParameterBag()->resolveValue($class) ?: null;
|
|
||||||
|
|
||||||
if (($r = ($r ?? $container->getReflectionClass($class))) && $r->hasMethod($defaultPriorityMethod)) {
|
|
||||||
if (!($rm = $r->getMethod($defaultPriorityMethod))->isStatic()) {
|
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should be static: tag "%s" on service "%s".', $class, $defaultPriorityMethod, $tagName, $serviceId));
|
|
||||||
}
|
}
|
||||||
|
$priority = $priority ?? $defaultPriority ?? $defaultPriority = 0;
|
||||||
|
|
||||||
if (!$rm->isPublic()) {
|
if (null === $indexAttribute && !$needsIndexes) {
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should be public: tag "%s" on service "%s".', $class, $defaultPriorityMethod, $tagName, $serviceId));
|
$services[] = [$priority, ++$i, null, $serviceId];
|
||||||
|
continue 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
$defaultPriority = $rm->invoke(null);
|
|
||||||
|
|
||||||
if (!\is_int($defaultPriority)) {
|
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should return an integer, got %s: tag "%s" on service "%s".', $class, $defaultPriorityMethod, \gettype($priority), $tagName, $serviceId));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$priority = $priority ?? $defaultPriority ?? 0;
|
|
||||||
|
|
||||||
if (null !== $indexAttribute && isset($attribute[$indexAttribute])) {
|
if (null !== $indexAttribute && isset($attribute[$indexAttribute])) {
|
||||||
$index = $attribute[$indexAttribute];
|
$index = $attribute[$indexAttribute];
|
||||||
} elseif (null === $defaultIndex && null === $indexAttribute && !$needsIndexes) {
|
|
||||||
// With partially associative array, insertion to get next key is simpler.
|
|
||||||
$services[$priority][] = null;
|
|
||||||
end($services[$priority]);
|
|
||||||
$defaultIndex = key($services[$priority]);
|
|
||||||
} elseif (null === $defaultIndex && $defaultIndexMethod) {
|
} elseif (null === $defaultIndex && $defaultIndexMethod) {
|
||||||
|
$defaultIndex = PriorityTaggedServiceUtil::getDefaultIndex($container, $serviceId, $defaultIndexMethod, $tagName, $indexAttribute);
|
||||||
|
}
|
||||||
|
$index = $index ?? $defaultIndex ?? $defaultIndex = $serviceId;
|
||||||
|
|
||||||
|
$services[] = [$priority, ++$i, $index, $serviceId];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uasort($services, static function ($a, $b) { return $b[0] <=> $a[0] ?: $a[1] <=> $b[1]; });
|
||||||
|
|
||||||
|
$refs = [];
|
||||||
|
foreach ($services as [, , $index, $serviceId]) {
|
||||||
|
if (null === $index) {
|
||||||
|
$refs[] = new Reference($serviceId);
|
||||||
|
} else {
|
||||||
|
$refs[$index] = new Reference($serviceId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $refs;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
|
class PriorityTaggedServiceUtil
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Gets the index defined by the default index method.
|
||||||
|
*/
|
||||||
|
public static function getDefaultIndex(ContainerBuilder $container, string $serviceId, string $defaultIndexMethod, string $tagName, string $indexAttribute): ?string
|
||||||
|
{
|
||||||
$class = $container->getDefinition($serviceId)->getClass();
|
$class = $container->getDefinition($serviceId)->getClass();
|
||||||
$class = $container->getParameterBag()->resolveValue($class) ?: null;
|
$class = $container->getParameterBag()->resolveValue($class) ?: null;
|
||||||
|
|
||||||
if (($r = ($r ?? $container->getReflectionClass($class))) && $r->hasMethod($defaultIndexMethod)) {
|
if (!($r = $container->getReflectionClass($class)) || !$r->hasMethod($defaultIndexMethod)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
if (!($rm = $r->getMethod($defaultIndexMethod))->isStatic()) {
|
if (!($rm = $r->getMethod($defaultIndexMethod))->isStatic()) {
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should be static: tag "%s" on service "%s" is missing "%s" attribute.', $class, $defaultIndexMethod, $tagName, $serviceId, $indexAttribute));
|
throw new InvalidArgumentException(sprintf('Either method "%s::%s()" should be static or tag "%s" on service "%s" is missing attribute "%s".', $class, $defaultIndexMethod, $tagName, $serviceId, $indexAttribute));
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$rm->isPublic()) {
|
if (!$rm->isPublic()) {
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should be public: tag "%s" on service "%s" is missing "%s" attribute.', $class, $defaultIndexMethod, $tagName, $serviceId, $indexAttribute));
|
throw new InvalidArgumentException(sprintf('Either method "%s::%s()" should be public or tag "%s" on service "%s" is missing attribute "%s".', $class, $defaultIndexMethod, $tagName, $serviceId, $indexAttribute));
|
||||||
}
|
}
|
||||||
|
|
||||||
$defaultIndex = $rm->invoke(null);
|
$defaultIndex = $rm->invoke(null);
|
||||||
|
|
||||||
if (!\is_string($defaultIndex)) {
|
if (!\is_string($defaultIndex)) {
|
||||||
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should return a string, got %s: tag "%s" on service "%s" is missing "%s" attribute.', $class, $defaultIndexMethod, \gettype($defaultIndex), $tagName, $serviceId, $indexAttribute));
|
throw new InvalidArgumentException(sprintf('Either method "%s::%s()" should return a string (got %s) or tag "%s" on service "%s" is missing attribute "%s".', $class, $defaultIndexMethod, \gettype($defaultIndex), $tagName, $serviceId, $indexAttribute));
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$defaultIndex = $defaultIndex ?? $serviceId;
|
return $defaultIndex;
|
||||||
}
|
}
|
||||||
|
|
||||||
$index = $index ?? $defaultIndex;
|
/**
|
||||||
|
* Gets the priority defined by the default priority method.
|
||||||
|
*/
|
||||||
|
public static function getDefaultPriority(ContainerBuilder $container, string $serviceId, string $defaultPriorityMethod, string $tagName): ?int
|
||||||
|
{
|
||||||
|
$class = $container->getDefinition($serviceId)->getClass();
|
||||||
|
$class = $container->getParameterBag()->resolveValue($class) ?: null;
|
||||||
|
|
||||||
$reference = null;
|
if (!($r = $container->getReflectionClass($class)) || !$r->hasMethod($defaultPriorityMethod)) {
|
||||||
if (!$class || 'stdClass' === $class) {
|
return null;
|
||||||
$reference = new Reference($serviceId);
|
|
||||||
} elseif ($index === $serviceId) {
|
|
||||||
$reference = new TypedReference($serviceId, $class);
|
|
||||||
} else {
|
|
||||||
$reference = new TypedReference($serviceId, $class, ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE, \is_string($index) ? $index : null);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$services[$priority][$index] = $reference;
|
if (!($rm = $r->getMethod($defaultPriorityMethod))->isStatic()) {
|
||||||
}
|
throw new InvalidArgumentException(sprintf('Either method "%s::%s()" should be static or tag "%s" on service "%s" is missing attribute "priority".', $class, $defaultPriorityMethod, $tagName, $serviceId));
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($services) {
|
if (!$rm->isPublic()) {
|
||||||
krsort($services);
|
throw new InvalidArgumentException(sprintf('Either method "%s::%s()" should be public or tag "%s" on service "%s" is missing attribute "priority".', $class, $defaultPriorityMethod, $tagName, $serviceId));
|
||||||
$services = array_merge(...$services);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $services;
|
$defaultPriority = $rm->invoke(null);
|
||||||
|
|
||||||
|
if (!\is_int($defaultPriority)) {
|
||||||
|
throw new InvalidArgumentException(sprintf('Method "%s::%s()" should return an integer (got %s) or tag "%s" on service "%s" is missing attribute "priority".', $class, $defaultPriorityMethod, \gettype($defaultPriority), $tagName, $serviceId));
|
||||||
|
}
|
||||||
|
|
||||||
|
return $defaultPriority;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -12,9 +12,11 @@
|
|||||||
namespace Symfony\Component\DependencyInjection\Tests\Compiler;
|
namespace Symfony\Component\DependencyInjection\Tests\Compiler;
|
||||||
|
|
||||||
use PHPUnit\Framework\TestCase;
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
|
||||||
use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
|
use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
use Symfony\Component\DependencyInjection\Reference;
|
use Symfony\Component\DependencyInjection\Reference;
|
||||||
|
use Symfony\Component\DependencyInjection\Tests\Fixtures\BarTagClass;
|
||||||
|
|
||||||
class PriorityTaggedServiceTraitTest extends TestCase
|
class PriorityTaggedServiceTraitTest extends TestCase
|
||||||
{
|
{
|
||||||
@ -85,6 +87,50 @@ class PriorityTaggedServiceTraitTest extends TestCase
|
|||||||
$priorityTaggedServiceTraitImplementation = new PriorityTaggedServiceTraitImplementation();
|
$priorityTaggedServiceTraitImplementation = new PriorityTaggedServiceTraitImplementation();
|
||||||
$this->assertEquals([], $priorityTaggedServiceTraitImplementation->test('my_custom_tag', $container));
|
$this->assertEquals([], $priorityTaggedServiceTraitImplementation->test('my_custom_tag', $container));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testOnlyTheFirstNonIndexedTagIsListed()
|
||||||
|
{
|
||||||
|
$container = new ContainerBuilder();
|
||||||
|
$container->register('service1')->addTag('my_custom_tag');
|
||||||
|
|
||||||
|
$definition = $container->register('service2', BarTagClass::class);
|
||||||
|
$definition->addTag('my_custom_tag', ['priority' => 100]);
|
||||||
|
$definition->addTag('my_custom_tag', []);
|
||||||
|
|
||||||
|
$priorityTaggedServiceTraitImplementation = new PriorityTaggedServiceTraitImplementation();
|
||||||
|
|
||||||
|
$expected = [
|
||||||
|
new Reference('service2'),
|
||||||
|
new Reference('service1'),
|
||||||
|
];
|
||||||
|
$this->assertEquals($expected, $priorityTaggedServiceTraitImplementation->test('my_custom_tag', $container));
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testOnlyTheIndexedTagsAreListed()
|
||||||
|
{
|
||||||
|
$container = new ContainerBuilder();
|
||||||
|
$container->register('service1')->addTag('my_custom_tag', ['foo' => 'bar']);
|
||||||
|
|
||||||
|
$definition = $container->register('service2', BarTagClass::class);
|
||||||
|
$definition->addTag('my_custom_tag', ['priority' => 100]);
|
||||||
|
$definition->addTag('my_custom_tag', ['foo' => 'a']);
|
||||||
|
$definition->addTag('my_custom_tag', ['foo' => 'b', 'priority' => 100]);
|
||||||
|
$definition->addTag('my_custom_tag', ['foo' => 'b']);
|
||||||
|
$definition->addTag('my_custom_tag', []);
|
||||||
|
|
||||||
|
$priorityTaggedServiceTraitImplementation = new PriorityTaggedServiceTraitImplementation();
|
||||||
|
|
||||||
|
$tag = new TaggedIteratorArgument('my_custom_tag', 'foo');
|
||||||
|
$expected = [
|
||||||
|
'bar_tag_class' => new Reference('service2'),
|
||||||
|
'b' => new Reference('service2'),
|
||||||
|
'bar' => new Reference('service1'),
|
||||||
|
'a' => new Reference('service2'),
|
||||||
|
];
|
||||||
|
$services = $priorityTaggedServiceTraitImplementation->test($tag, $container);
|
||||||
|
$this->assertSame(array_keys($expected), array_keys($services));
|
||||||
|
$this->assertEquals($expected, $priorityTaggedServiceTraitImplementation->test($tag, $container));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class PriorityTaggedServiceTraitImplementation
|
class PriorityTaggedServiceTraitImplementation
|
||||||
|
Reference in New Issue
Block a user