[DependencyInjection] Define default priority inside service class #31943

pcabreus · 2019-06-07T20:40:13Z

Q	A
Branch?	4.4 for features
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#...
License	MIT

With autoconfigure functions we don't have to do much to inject tagged services into a collector using interfaces, using !tagged is the easy way. But if we need some order we have to use priority, the problem is that priority only can be set by configuration file when it is a simple value.
This PR take a look if the static method getDefaultPriority exists in the service class and return its default value for the service instead of current 0 by defualt.

Example of a service with default priority:

<?php
namespace App;
use App\ServiceTagged;
class Service implement ServiceTagged
{
    public static function getDefaultPriority(): int
    {
        return 50; //This will be the default priority if it's not defined in a configuration file
    }
}
?>

PD: First PR please by nice!

With autoconfigure functions we don't have to do anything to inject tagged services into a collector using interfaces to define tags. But if we need some order we have to use priority, the problem is that priority only can be set by configuration file when it is a simple value. With this change you could instead of put 0 by defualt take a look if the static method `getDefaultPriority` exists in the service class and return its default value for the service. Example: <?php namespace App; use App\ServiceTagged; class Service implement ServiceTagged { public static function getDefaultPriority(): int { return 50; //This will be the default priority if it's not defined in a configuration file } } ?>

yceruto

Hola! Congratulations for your first attempt :) 🎉

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

It looks like `YamlFileLoader` makes `index_by` mandatory when you define the tagged service using `arguments: [!tagged { tag: 'app.handler'}]` syntax. It's needed to accept others parameters like the new `default_priority_method` without specify `index_by` and the `XmlFielLoader` seems to accept it.

yceruto

Others code standard that aren't cover by fabbot.io:

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php

src/Symfony/Component/DependencyInjection/CHANGELOG.md

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

Co-Authored-By: Valentin Udaltsov <[email protected]>

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

Co-Authored-By: Kevin Verschaeve <[email protected]>

This documents symfony/symfony#31943 about adding a custom method to define the priority of services

nicolas-grekas

Thanks and sorry for the late review.
Here are some comments. Please rebase also.
Looks good to me otherwise.

nicolas-grekas · 2020-09-04T11:50:15Z

src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php

@@ -118,27 +118,27 @@ function iterator(array $values): IteratorArgument
 *
 * @deprecated since Symfony 4.4, to be removed in 5.0, use "tagged_iterator" instead.
 */
-function tagged(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument
+function tagged(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, bool $needsIndexes = false, string $defaultPriorityMethod = null): TaggedIteratorArgument


should be reverted, this function is deprecated, no need to alter it

nicolas-grekas · 2020-09-04T11:50:36Z

src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php

 }

 /**
 * Creates a lazy iterator by tag name.
 */
-function tagged_iterator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument
+function tagged_iterator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, bool $needsIndexes = false, string $defaultPriorityMethod = null): TaggedIteratorArgument


$needsIndexes should be removed, it's always false for iterators

nicolas-grekas · 2020-09-04T11:50:51Z

src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php

 }

 /**
 * Creates a service locator by tag name.
 */
-function tagged_locator(string $tag, string $indexAttribute, string $defaultIndexMethod = null): ServiceLocatorArgument
+function tagged_locator(string $tag, string $indexAttribute, string $defaultIndexMethod = null, bool $needsIndexes = true, string $defaultPriorityMethod = null): ServiceLocatorArgument


$needsIndexes should be removed, it's always true for locators

nicolas-grekas · 2020-09-04T11:59:22Z

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

-            $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;
+            $class = $container->getDefinition($serviceId)->getClass();
+            $class = $container->getParameterBag()->resolveValue($class) ?: null;
+            $reflectionClass = $container->getReflectionClass($class);


this line must be executed only if null !== $defaultPriorityMethod and $attributes[0]['priority'] is not set, so that we don't autoload a class for nothing when not needed

nicolas-grekas · 2020-09-04T12:05:04Z

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

                throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $serviceId));
            }

-            $class = $r->name;
+            $class = $reflectionClass->name;


let's keep $r as the name here, that will reduce the diff, thus reduce future merge conflicts

nicolas-grekas · 2020-09-04T12:49:22Z

Wait, this has already been implemented in #33628!
Thanks for pushing this forward and sorry for the confusion.

carsonbot added Status: Needs Review Feature labels Jun 7, 2019

nicolas-grekas added this to the next milestone Jun 7, 2019

yceruto reviewed Jun 7, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php Outdated Show resolved Hide resolved

pcabreus added 4 commits June 9, 2019 23:02

added ability to define an priority method for a tagged collection

2df617e

Merge branch '4.4' into patch-1

4fed2a3

fixed fabbot.io code standard

b6069b2

yceruto reviewed Jun 10, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php Outdated Show resolved Hide resolved

src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php Outdated Show resolved Hide resolved

vudaltsov suggested changes Jun 11, 2019

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 11, 2019

pcabreus and others added 5 commits June 11, 2019 10:10

fixed spell

5498824

Co-Authored-By: Valentin Udaltsov <[email protected]>

compare using null

8ab9cfd

Co-Authored-By: Valentin Udaltsov <[email protected]>

better exception decription

f48eea9

Co-Authored-By: Valentin Udaltsov <[email protected]>

fixed some code standard

c021fc8

fixed some code standard

2d8fd1f

kevin-verschaeve reviewed Jun 11, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php Outdated Show resolved Hide resolved

pcabreus and others added 3 commits June 12, 2019 08:24

fixed arguments order

6b51ac5

Co-Authored-By: Kevin Verschaeve <[email protected]>

using the tagged_iterator instead deprecated tagged

b9dd5eb

optional priority method unless you define it

41f5e99

pcabreus mentioned this pull request Jun 12, 2019

adding a custom method to define the priority of services symfony/symfony-docs#11731

Closed

pcabreus added a commit to pcabreus/symfony-docs that referenced this pull request Jun 20, 2019

adding a custom method to define the priority of services

3b328b8

This documents symfony/symfony#31943 about adding a custom method to define the priority of services

pcabreus mentioned this pull request Jun 20, 2019

adding a custom method to define the priority of services pcabreus/symfony-docs#1

Open

nicolas-grekas changed the title ~~Define default priority inside service class~~ [DependencyInjection] Define default priority inside service class Sep 3, 2020

nicolas-grekas reviewed Sep 4, 2020

View reviewed changes

nicolas-grekas closed this Sep 4, 2020

nicolas-grekas removed this from the next milestone Oct 5, 2020

nicolas-grekas added this to the 5.2 milestone Oct 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Define default priority inside service class #31943

[DependencyInjection] Define default priority inside service class #31943

pcabreus commented Jun 7, 2019 •

edited

Loading

yceruto left a comment •

edited

Loading

yceruto left a comment

nicolas-grekas left a comment

nicolas-grekas Sep 4, 2020

nicolas-grekas Sep 4, 2020

nicolas-grekas Sep 4, 2020

nicolas-grekas Sep 4, 2020

nicolas-grekas Sep 4, 2020

nicolas-grekas commented Sep 4, 2020

[DependencyInjection] Define default priority inside service class #31943

[DependencyInjection] Define default priority inside service class #31943

Conversation

pcabreus commented Jun 7, 2019 • edited Loading

yceruto left a comment • edited Loading

Choose a reason for hiding this comment

yceruto left a comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas Sep 4, 2020

Choose a reason for hiding this comment

nicolas-grekas Sep 4, 2020

Choose a reason for hiding this comment

nicolas-grekas Sep 4, 2020

Choose a reason for hiding this comment

nicolas-grekas Sep 4, 2020

Choose a reason for hiding this comment

nicolas-grekas Sep 4, 2020

Choose a reason for hiding this comment

nicolas-grekas commented Sep 4, 2020

pcabreus commented Jun 7, 2019 •

edited

Loading

yceruto left a comment •

edited

Loading