[DependencyInjection] Add "instanceof" section for local interface-defined configs #21530

nicolas-grekas · 2017-02-04T13:58:00Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

This is a direction follow up of #21357 on which we're working together with @dunglas. From the description posted there:

There is some work being done to include features of DunglasActionBundle in the core of Symfony. The goal of all those PRs is to improve the developper experience of the framework, allow to develop faster while preserving all benefits of using Symfony (strictness, modularity, extensibility...) and make it easier to learn for newcomers.

This PR implements the tagging feature of ActionBundle in a more generic way. It will help to get rid of AppBundle in the the standard edition and to register automatically some classes including commands.

Here is an example of config (that can be embedded in the standard edition) to enable those features:

# config/services.yml
services:
    _defaults:
        # Enable constructor and getter autowiring for all services defined in this file
        autowire: ['get*']
        public: false

    _instanceof:
        # Add the console.command tag to all services defined in this file having this type
        Symfony\Component\Console\Command\Command:
            tags: ['console.command']
            public: true # commands must be public

        Twig_ExtensionInterface:
            tags: ['twig.extension']

        Symfony\Component\EventDispatcher\EventSubscriberInterface:
            tags: ['kernel.event_subscriber']

    # Register all classes in these directories as services
    App\:
        resource: ../src/{Action,Command,EventSubscriber,Twig}

It's part of our 0 config initiative: controllers and commands will be automatically registered as services and "autowired", allowing the user to create and inject new services without having to write a single line of YAML or XML.
When refactoring changes are also automatically updated and don't require to update config files. It's a big win for rapid application development and prototyping.

Of course, this is fully compatible with the actual way of defining services and it's possible to switch (or mix) approaches very easily. It's even possible to start prototyping using 0config features then switch to explicit services definitions when the project becomes mature.

stof · 2017-02-07T09:00:59Z

what happens when you use a parameter as class name for the service (which is still supported even though we discourage its usage in the doc) ?

stof · 2017-02-07T09:03:48Z

src/Symfony/Component/DependencyInjection/ChildDefinition.php

@@ -26,7 +26,7 @@ class ChildDefinition extends Definition
    private $changes = array();

    /**
-     * @param string $parent The id of Definition instance to decorate
+     * @param string|null $parent The id of Definition instance to decorate


I don't like the idea of allowing null here. A ChildDefinition registered in the container must not have a null parent id (it would break things).

If you use a ChildDefinition temporarily to resolve instanceof configurations in the loaders, I would rather use a dummy parent id (which will not go outside the loader anyway)

stof · 2017-02-07T09:04:24Z

what happens when the service class matches multiple _instanceof ? and what happens for services defined using a factory ?

nicolas-grekas · 2017-02-07T10:42:41Z

what happens when you use a parameter as class name for the service?

the class is resolved using the parameterbag already.
of course that can't account for params added later in compiler passes.
in that case (ie when the class is missing really), nothing special happens (ie we continue as usual).
See ResolveDefinitionTemplatesPass.php

what happens when the service class matches multiple _instanceof ?

they are applied on top of each others in declaration order

and what happens for services defined using a factory ?

nothing special: we use the "class" attribute, which we deprecated not defining, so we can use "instanceof" even in the case of factories.

stof · 2017-02-07T10:47:32Z

src/Symfony/Component/DependencyInjection/Definition.php

@@ -356,6 +357,24 @@ public function getOverriddenGetters()
    }

    /**
+     * @experimental in version 3.3
+     */
+    public function setInstanceofConditionals(array $instanceof)


we should document the type of the argument (what is inside the array ?)

stof · 2017-02-07T10:47:51Z

src/Symfony/Component/DependencyInjection/Definition.php

+    /**
+     * @experimental in version 3.3
+     */
+    public function getInstanceofConditionals()


we should document the returned type (an array of something, but what ?)

fabpot · 2017-02-12T19:27:49Z

src/Symfony/Component/DependencyInjection/Definition.php

+    }
+
+    /**
+     * Gets the definition templates to conditionally apply on the current definition, keyed by parent interface/class


Missing dot at the end.

dunglas · 2017-02-17T16:01:34Z

👍

fabpot · 2017-02-17T18:34:04Z

src/Symfony/Component/DependencyInjection/Loader/FileLoader.php

+    {
+        if ($this->isLoadingInstanceof) {
+            if (!$definition instanceof ChildDefinition) {
+                throw new InvalidArgumentException(sprintf('Invalid type definition "%s": ChildDefinition expected, %s given.', $id, get_class($definition)));


missing " around the second %s

…fined configs

fabpot · 2017-02-17T18:45:36Z

Thank you @nicolas-grekas.

@dunglas

…al interface-defined configs (nicolas-grekas, dunglas) This PR was merged into the 3.3-dev branch. Discussion ---------- [DependencyInjection] Add "instanceof" section for local interface-defined configs | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - This is a direction follow up of #21357 on which we're working together with @dunglas. From the description posted there: There is some work being done to include features of [DunglasActionBundle](https://github.com/dunglas/DunglasActionBundle) in the core of Symfony. The goal of all those PRs is to improve the developper experience of the framework, allow to develop faster while preserving all benefits of using Symfony (strictness, modularity, extensibility...) and make it easier to learn for newcomers. This PR implements the tagging feature of ActionBundle in a more generic way. It will help to get rid of `AppBundle` in the the standard edition and to register automatically some classes including commands. Here is an example of config (that can be embedded in the standard edition) to enable those features: ```yaml # config/services.yml services: _defaults: autowire: ['get*', 'set*'] # Enable constructor, getter and setter autowiring for all services defined in this file _instanceof: Symfony\Component\Console\Command: # Add the console.command tag to all services defined in this file having this type tags: ['console.command'] # Set tags but also other settings like "public", "autowire" or "shared" here Twig_ExtensionInterface: tags: ['twig.extension'] Symfony\Component\EventDispatcher\EventSubscriberInterface: tags: ['kernel.event_subscriber'] App\: # Register all classes in the src/Controller directory as services psr4: ../src/{Controller,Command,Twig,EventSubscriber} ``` It's part of our 0 config initiative: controllers and commands will be automatically registered as services and "autowired", allowing the user to create and inject new services without having to write a single line of YAML or XML. When refactoring changes are also automatically updated and don't require to update config files. It's a big win for rapid application development and prototyping. Of course, this is fully compatible with the actual way of defining services and it's possible to switch (or mix) approaches very easily. It's even possible to start prototyping using 0config features then switch to explicit services definitions when the project becomes mature. Commits ------- 773eca7 [DependencyInjection] Tests + refacto for "instanceof" definitions 2fb6019 [DependencyInjection] Add "instanceof" section for local interface-defined configs

nicolas-grekas added this to the 3.3 milestone Feb 4, 2017

carsonbot added Status: Needs Review DependencyInjection Feature labels Feb 4, 2017

nicolas-grekas mentioned this pull request Feb 4, 2017

[DependencyInjection] ActionBundle integration: introduce _instanceof #21357

Closed

1 task

nicolas-grekas force-pushed the instanceof branch 3 times, most recently from ae6c98f to 1948bcd Compare February 4, 2017 14:11

stof reviewed Feb 7, 2017

View reviewed changes

nicolas-grekas force-pushed the instanceof branch from 1948bcd to 28b7922 Compare February 7, 2017 10:28

stof reviewed Feb 7, 2017

View reviewed changes

nicolas-grekas force-pushed the instanceof branch 7 times, most recently from 24d8139 to 8f5a69d Compare February 9, 2017 14:38

nicolas-grekas added the Ready label Feb 11, 2017

fabpot reviewed Feb 12, 2017

View reviewed changes

nicolas-grekas force-pushed the instanceof branch 7 times, most recently from 9f89907 to a06d87c Compare February 13, 2017 15:56

nicolas-grekas mentioned this pull request Feb 14, 2017

[DependencyInjection] Create an util class to determine services implementing a FQCN #20940

Closed

hhamon mentioned this pull request Feb 16, 2017

[DependencyInjection] fix support of inherited tags in child services definitions. #21629

Closed

nicolas-grekas force-pushed the instanceof branch 3 times, most recently from 236cd01 to c611187 Compare February 17, 2017 15:45

fabpot reviewed Feb 17, 2017

View reviewed changes

nicolas-grekas and others added 2 commits February 17, 2017 19:36

[DependencyInjection] Add "instanceof" section for local interface-de…

2fb6019

…fined configs

[DependencyInjection] Tests + refacto for "instanceof" definitions

773eca7

nicolas-grekas force-pushed the instanceof branch from c611187 to 773eca7 Compare February 17, 2017 18:36

fabpot merged commit 773eca7 into symfony:master Feb 17, 2017

nicolas-grekas deleted the instanceof branch February 17, 2017 22:04

javiereguiluz mentioned this pull request Feb 26, 2017

Document the new _instanceof section for services configuration symfony/symfony-docs#7538

Closed

weaverryan mentioned this pull request Apr 5, 2017

[DI] Rework config hierarchy: defaults > instanceof > service config #22294

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

ghost mentioned this pull request Feb 7, 2018

[Container][Tags] Added a note about _instanceof symfony/symfony-docs#9221

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Add "instanceof" section for local interface-defined configs #21530

[DependencyInjection] Add "instanceof" section for local interface-defined configs #21530

nicolas-grekas commented Feb 4, 2017 •

edited

Loading

stof commented Feb 7, 2017

stof Feb 7, 2017

nicolas-grekas Feb 7, 2017

stof commented Feb 7, 2017

nicolas-grekas commented Feb 7, 2017

stof Feb 7, 2017

nicolas-grekas Feb 7, 2017

stof Feb 7, 2017

nicolas-grekas Feb 7, 2017

fabpot Feb 12, 2017

nicolas-grekas Feb 12, 2017

dunglas commented Feb 17, 2017

fabpot Feb 17, 2017

nicolas-grekas Feb 17, 2017

fabpot commented Feb 17, 2017

[DependencyInjection] Add "instanceof" section for local interface-defined configs #21530

[DependencyInjection] Add "instanceof" section for local interface-defined configs #21530

Conversation

nicolas-grekas commented Feb 4, 2017 • edited Loading

stof commented Feb 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Feb 7, 2017

nicolas-grekas commented Feb 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Feb 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Feb 17, 2017

nicolas-grekas commented Feb 4, 2017 •

edited

Loading