[FrameworkBundle], [DependencyInjection] added logging of unused tags #11744

Marmelatze · 2014-08-23T14:30:02Z

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

I gave this a short shot and added a new CompilerPass to log all tags, which are not queried by ContainerBuilder::findTaggedServiceIds().
Example log:

[2014-08-23 15:45:32] app.WARNING: Tag "kenrel.event_listener" was defined on the service(s) foo.bar_service, but was never used. Did you mean "kernel.event_listener"

This is maybe not the best solution, for tags defined in optional bundles. So I added a ignore configuration option for this case.

Configuration:

framework:
    compiler:
        validate:
            tags:
                enabled: true
                ignore:
                    - foo.bar

A better approach could be a explicit declaration of the tags and their arguments? Maybe in the extension class of the regarding bundle? But what should happen when a 3rd party bundle doesn't add such declaration?

wouterj · 2014-08-23T20:57:23Z

Why isn't this BC?

wouterj · 2014-08-23T20:57:41Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php

@@ -0,0 +1,48 @@
+<?php
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;


you're missing the license file header, take a look at the other files

Marmelatze · 2014-08-25T10:23:11Z

Thanks for the feedback, I changed the code according to your suggestions.
This should be BC, as the configuration is optional, isn't it?

stof · 2014-08-25T10:47:05Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php

+        $ignore = $container->getParameter('compiler.validate.ignore_unused_tag.ignore');
+
+        $tags = $container->findTags();
+        $logger = $container->get('logger');


you should never get a service in a compiler pass. This is the process of building the container. Using the container in this step can lead to weird bugs.

If you want to log some stuff during the container creation, it should go in the DIC compiling logs

stof · 2014-08-25T10:49:41Z

the XSd must be updated as well

fabpot · 2014-08-28T01:19:34Z

DX is all about simplifying the life of the developer. So, I would definitely not make this "feature" configurable. To me, it does not make sense to configure the validation of tags in case people made typos. I do understand the possibility to break BC here but as we only talking about warnings in the logs, it seems ok to me. Instead, I would whitelist all built-in tags, that should cover most use cases.

jakzal · 2014-09-11T21:19:51Z

src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php

        ), '->findTaggedServiceIds() returns an array of service ids and its tag attributes');
        $this->assertEquals(array(), $builder->findTaggedServiceIds('foobar'), '->findTaggedServiceIds() returns an empty array if there is annotated services');
    }

+    public function testfindUnusedTags()


testFindUnusedTags

fabpot · 2014-09-15T18:33:00Z

@Marmelatze What's the status of this PR? Do you have time to finish it? Do you need some help?

Marmelatze · 2014-09-18T14:19:46Z

Sorry I didn't have much time, lately. I integrated all the changes into the PR

weaverryan · 2014-09-22T16:03:16Z

I obviously like this idea, but it does seem odd that we have a hard-coded list of the whitelisted tags. If another bundle/library introduced their own tags, they would get the warning about it being unused. So now we have the positive of helping people catch typos (though I don't know how many people will check the logs) with the negative of giving people a false message in some cases.

stof · 2014-09-25T15:59:35Z

@weaverryan if the bundle introducing the tags is registered, the tags are likely to be used. The false positive is if a bundle contains an integration layer with another bundle not registered in your project, relying on a tag for this.

Regarding the case of checking the logs, maybe we should have a DataCollector looking at the container compiler logs and extracting these warnings to display them in the profiler (it would probably require adding WARNING in the message to allow identifying warning messages easily without limiting them to this particular compiler pass)

weaverryan · 2014-09-25T16:42:58Z

@stof You're right - this PR is doing more intelligent things than I was giving it credit for.

I also like your idea of raising something on the WDT if we have a log message above a certain level. The WDT is getting a bit busy, but this is exactly the type of info I'd want - it's more important at that moment than really anything else :).

Btw, I actually do see people misspell tags fairly commonly - kernal.event_listener :). But I'm not sure this will help them unless we try to get the message in front of their face.

Thanks!

stof · 2014-09-25T19:48:37Z

The WDT panel can be added in a separate PR though

fabpot · 2014-09-26T05:41:36Z

Regarding the WDT, there is no need to add anything as the logger already warns you when you have errors in your code. If we really think the user made a typo, I would log an error, not a warning anyway.

fabpot · 2014-09-26T05:43:43Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php

+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Find all service tags which are defined, but not used an yield a warning log message.


typo: and yield a warning

fabpot · 2014-09-26T05:48:07Z

Forget about my comment, it cannot be an error as we might have false positives here. But adding a WDT panel for that seems wrong to me. It should be part of some other existing panels.

fabpot · 2014-09-26T05:49:24Z

Besides my small comments about code CS, I'm 👍 as a first step towards the end goal.

Marmelatze · 2014-09-26T08:47:08Z

Made the style changes, should I add the two tags (routing.expression_language_provider, security.expression_language_provider)?
The fabbot and travis failures seem to be unrelated?

stof · 2014-09-26T09:16:47Z

there is no need to add anything as the logger already warns you when you have errors in your code

We are talking about container compiling logs here (most of them are debugging message though, and not useful for users until they want to debug why a service disappeared from their container), not about the logger service

unkind · 2014-10-12T07:19:49Z

src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php

+            ->addTag('kenrel.event_listener', array('bar' => 'bar'))
+        ;
+        $builder->findTaggedServiceIds('kernel.event_listener');
+        $this->assertEquals($builder->findUnusedTags(), array(


$this->assertEquals() takes expected value as 1st argument.

… during container compilation

fabpot · 2015-02-05T15:33:00Z

@Marmelatze Can you some more tests as currently, the pass is not tested at all. Can you also add the missing tags that were added since then as well? Thanks.

stof · 2015-08-01T17:53:36Z

ping

Marmelatze · 2015-08-01T17:56:24Z

Oh sorry totally forgot about this, is it still relevant? I have time to look into this in a few weeks.

fabpot · 2015-08-03T08:57:44Z

@Marmelatze I think it's still relevant

fabpot · 2015-09-28T11:04:11Z

Closing in favor of #15963 where I've resolved the conflict, added some tests, made some minor tweaks, and fixed some minor bugs

This PR was merged into the 2.8 branch. Discussion ---------- added logging of unused tags | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11511, #11744 | License | MIT | Doc PR | - This is the same as #11744 but with some minor tweaks and some unit tests for the compiler pass. Commits ------- 95c9f50 added some tests d3271e1 missing tags in whitelist f51fe4a [FrameworkBundle] [DependencyInjection] added logging of unused tags during container compilation

Marmelatze force-pushed the unused_tags branch from 10f129b to e874ab1 Compare August 23, 2014 19:09

wouterj reviewed Aug 23, 2014
View reviewed changes

Marmelatze force-pushed the unused_tags branch from e874ab1 to 4c9172f Compare August 25, 2014 10:21

stof reviewed Aug 25, 2014
View reviewed changes

Marmelatze force-pushed the unused_tags branch 2 times, most recently from 02112bb to 5e103e2 Compare August 26, 2014 07:32

fabpot added DependencyInjection labels Sep 5, 2014

Marmelatze force-pushed the unused_tags branch 3 times, most recently from f3fd9aa to 8800778 Compare September 5, 2014 08:12

jakzal reviewed Sep 11, 2014
View reviewed changes

Marmelatze force-pushed the unused_tags branch from 8800778 to 08e6214 Compare September 18, 2014 14:18

fabpot reviewed Sep 26, 2014
View reviewed changes

Marmelatze force-pushed the unused_tags branch 2 times, most recently from 011b4cd to 6f94e8e Compare September 26, 2014 08:09

unkind reviewed Oct 12, 2014
View reviewed changes

Marmelatze force-pushed the unused_tags branch from 6f94e8e to e20c787 Compare October 15, 2014 10:28

[FrameworkBundle], [DependencyInjection] added logging of unused tags…

415f068

… during container compilation

Marmelatze force-pushed the unused_tags branch from e20c787 to 415f068 Compare October 29, 2014 09:16

fabpot mentioned this pull request Sep 28, 2015

added logging of unused tags #15963

Merged

fabpot closed this Sep 28, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle], [DependencyInjection] added logging of unused tags #11744

[FrameworkBundle], [DependencyInjection] added logging of unused tags #11744

Marmelatze commented Aug 23, 2014

wouterj commented Aug 23, 2014

wouterj Aug 23, 2014

Marmelatze commented Aug 25, 2014

stof Aug 25, 2014

stof commented Aug 25, 2014

fabpot commented Aug 28, 2014

jakzal Sep 11, 2014

fabpot commented Sep 15, 2014

Marmelatze commented Sep 18, 2014

weaverryan commented Sep 22, 2014

stof commented Sep 25, 2014

weaverryan commented Sep 25, 2014

stof commented Sep 25, 2014

fabpot commented Sep 26, 2014

fabpot Sep 26, 2014

fabpot commented Sep 26, 2014

fabpot commented Sep 26, 2014

Marmelatze commented Sep 26, 2014

stof commented Sep 26, 2014

unkind Oct 12, 2014

fabpot commented Feb 5, 2015

stof commented Aug 1, 2015

Marmelatze commented Aug 1, 2015

fabpot commented Aug 3, 2015

fabpot commented Sep 28, 2015

		@@ -0,0 +1,48 @@
		<?php
		namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;

[FrameworkBundle], [DependencyInjection] added logging of unused tags #11744

[FrameworkBundle], [DependencyInjection] added logging of unused tags #11744

Conversation

Marmelatze commented Aug 23, 2014

wouterj commented Aug 23, 2014

wouterj Aug 23, 2014

Choose a reason for hiding this comment

Marmelatze commented Aug 25, 2014

stof Aug 25, 2014

Choose a reason for hiding this comment

stof commented Aug 25, 2014

fabpot commented Aug 28, 2014

jakzal Sep 11, 2014

Choose a reason for hiding this comment

fabpot commented Sep 15, 2014

Marmelatze commented Sep 18, 2014

weaverryan commented Sep 22, 2014

stof commented Sep 25, 2014

weaverryan commented Sep 25, 2014

stof commented Sep 25, 2014

fabpot commented Sep 26, 2014

fabpot Sep 26, 2014

Choose a reason for hiding this comment

fabpot commented Sep 26, 2014

fabpot commented Sep 26, 2014

Marmelatze commented Sep 26, 2014

stof commented Sep 26, 2014

unkind Oct 12, 2014

Choose a reason for hiding this comment

fabpot commented Feb 5, 2015

stof commented Aug 1, 2015

Marmelatze commented Aug 1, 2015

fabpot commented Aug 3, 2015

fabpot commented Sep 28, 2015