-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Created a trait to sort tagged services #18482
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,7 +21,7 @@ public function testThatCheckersAreProcessedInPriorityOrder() | |
$services = array( | ||
'checker_2' => array(0 => array('priority' => 100)), | ||
'checker_1' => array(0 => array('priority' => 200)), | ||
'checker_3' => array(), | ||
'checker_3' => array(0 => array()), | ||
); | ||
|
||
$definition = $this->getMock('Symfony\Component\DependencyInjection\Definition'); | ||
|
@@ -52,7 +52,6 @@ public function testThatCheckersAreProcessedInPriorityOrder() | |
|
||
public function testThatCheckersCanBeMissing() | ||
{ | ||
$definition = $this->getMock('Symfony\Component\DependencyInjection\Definition'); | ||
$container = $this->getMock( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Was unused |
||
'Symfony\Component\DependencyInjection\ContainerBuilder', | ||
array('findTaggedServiceIds') | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
<?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; | ||
|
||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Reference; | ||
|
||
/** | ||
* Trait that allows a generic method to find and sort service by priority option in the tag. | ||
* | ||
* @author Iltar van der Berg <kjarli@gmail.com> | ||
*/ | ||
trait PriorityTaggedServiceTrait | ||
{ | ||
/** | ||
* Finds all services with the given tag name and order them by their priority. | ||
* | ||
* @param string $tagName | ||
* @param ContainerBuilder $container | ||
* | ||
* @return Reference[] | ||
*/ | ||
private function findAndSortTaggedServices($tagName, ContainerBuilder $container) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we consider There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think so as they are public to the class they are used in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this would need an update on the bc policy! |
||
{ | ||
$services = $container->findTaggedServiceIds($tagName); | ||
|
||
$queue = new \SplPriorityQueue(); | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR made me think about handling priorities for formatters in #18450, but even if I love @javiereguiluz proposal to use So I'm wondering even if the context is a bit different here, what about checking classes of tagged services to prevent one class to be registered with many service ids? Is this an expected possibility? Shouldn't we throw an exception in such case and add a test for it? We could hold a $services = $container->findTaggedServiceIds($tagName);
$queue = new \SplPriorityQueue();
$classes = array();
foreach ($services as $serviceId => $tags) {
$serviceClass = $container->findDefinition($serviceId)->getClass();
if ($serviceClass && isset($classes[$serviceClass]) {
throw new InvalidArgumentException(sprintf('The service "%s" has the same "%s" class as service "%s"', $serviceId, $serviceClass, $classes[$serviceClass]);
}
$classes[$attributes['class']] = $serviceId;
foreach ($tags as $attributes) {
$priority = isset($attributes['priority']) ? $attributes['priority'] : 0;
$queue->insert(new Reference($serviceId), $priority * -1);
}
return iterator_to_array($queue);
} What do you think ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've thought about the situation but that would be a BC break as that case is possible right now There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could still trigger a warning as silenced error to throw an exception in 4.0 (if it worths it)? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think there can be legit use-cases where you would want to something twice with a different priority.. I just don't think it's a smart idea. @stof usually you have a very good idea about things like this, what do you think? Adding a deprecation warning and adding it anyway (behavioral change only in 4.0) seems fine to me. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Having several instances of the same class is a reasonable expectation. Think in terms of dependency injection: you can define 2 services using the same class and having a different configuration. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What I think @HeahDude is referring to is not once a class, but once a service There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @GromNaN @phansys, I understand your POV, and I agree in a global scope and I don't know about cache warmers. If there is a legit use case for it, my guess is that there is also a chance that happens while misconfiguration or unexpected duplication (or overriding) with different id, so the user should know about it. Or maybe we could just add a test for duplicated class in debug:container command, so we can easily check such case? I mean their are factories for those use cases, it could help debugging definitions issues. Or what about using a parameter like: private function findAndSortTaggedServices($tagName, ContainerBuilder $container, $uniqueClasses = false) To perform a check only if necessary mandatory for a service's tag collection? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. services:
app.listener.log_request_mail:
class: App\Listener\LogRequest
arguments: ["@logger.mail"]
tags: [{name: kernel.request, priority: 100}]
app.listener.log_request_udp:
class: App\Listener\LogRequest
arguments: ["@logger.udp"]
tags: [{name: kernel.request, priority: 50}] This is what would register only the first one with your example. If it was unique per service, only the first encountered of each would be logged: services:
app.listener.log_request_mail:
class: App\Listener\LogRequest
arguments: ["@logger.mail"]
tags: [{name: kernel.request, priority: 100}, {name: kernel.request, priority: 50}]
app.listener.log_request_udp:
class: App\Listener\LogRequest
arguments: ["@logger.udp"]
tags: [{name: kernel.request, priority: 50}, {name: kernel.request, priority: 100}] So by service id is feasible as this example makes no sense in the first place. However, it would also mean that the mail would be registered as 100 and the udp with 50. Imo regarding this PR, I think I'll leave this as is. If it's a behavior that needs to be changed, a PR can be opened to deprecated it as 3.4 and 4.0 are still 1.5 year away. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR is indeed very good as is, thanks for that. I've just been confused by this behavior, sorry for this digression :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just to be sure (ref #18450 (comment)). This PR make some passes use a trait to collect tagged services, are concerned:
Excepted 1 and 4, these interfaces have kind of a After a deep look at each of them, I ask again, does it really make sense to allow duplicated service classes with different service IDs or with different priorities? Should't this be tested? Or is it the responsibility of each service using them to perform that check? Because currently, it seems nothing is preventing it. |
||
foreach ($services as $serviceId => $tags) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we use SplPriorityQueue? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have to admit that I've not used it before, but it looks interesting. On Fri, 8 Apr 2016 16:32 Javier Eguiluz, notifications@github.com wrote:
|
||
foreach ($tags as $attributes) { | ||
$priority = isset($attributes['priority']) ? $attributes['priority'] : 0; | ||
$queue->insert(new Reference($serviceId), $priority * -1); | ||
} | ||
} | ||
|
||
return iterator_to_array($queue); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
had to fix this in the tests because the container method wouldn't return like this, same goes for the other test.