[DI] Deprecate XML services without ID #22903

ro0NL · 2017-05-25T06:57:27Z

Q	A
Branch?	3.4
Bug fix?	no, confusing though
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#...
License	MIT
Doc PR	symfony/symfony-docs#...

On slack someone had a issue with class named services;

So, probably should have done this sooner, I stepped through with a debugger and it looks like \Symfony\Component\DependencyInjection\Loader\XmlFileLoader::processAnonymousServices assigns a sha256 to services that don't have any IDs
When my manually wired service is registered, it has an ID that looks like 1_344b468f6069ffe8c32092409d99c59abc218f41071ce4c4230c198876129bc0, so it doesn't override the auto-loaded one
I swear I read that IDs default to the class name now...

The fix was easy; doing <service id="ClassName"/> instead of <service class="ClassName"/>. However the thing is... i made the exact same mistake trying to reproduce 😅

I think given the recent developments (dropping type based autowiring and class named services) it makes sense to force XML service to specify an ID attribute (the top level ones). This would be consistent with YAML and PHP as well.

Fixing deprecations is also easy, just change class attribute to id like i've done for the frameworkbundle in this PR.

Any thoughts?

nicolas-grekas

👍 makes sense to me

nicolas-grekas · 2017-05-25T07:12:41Z

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

+                ++$num;
+            }
+            if ($num) {
+                @trigger_error(sprintf('Anonymous services (%d) in file %s are deprecated since 3.4 and wont be supported in 4.0', $num, $file), E_USER_DEPRECATED);


imho, no need for $num. To be a bit more explicit, I propose:
Anonymous services are deprecated since Symfony 3.4, the "id" attribute will be required in version 4.0 in %s.

it will allow for missing deprecations more easy that way, but that's more or less related to loose comparison of those.

Updated :)

ro0NL · 2017-05-25T07:45:04Z

failures unrelated.

ro0NL · 2017-05-25T07:58:27Z

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

@@ -412,6 +412,10 @@ private function processAnonymousServices(\DOMDocument $xml, $file, $defaults)

        // anonymous services "in the wild"
        if (false !== $nodes = $xpath->query('//container:services/container:service[not(@id)]')) {
+            if ($nodes->length) {
+                @trigger_error(sprintf('Anonymous services are deprecated since Symfony 3.4, the "id" attribute will be required in version 4.0 in %s.', $file), E_USER_DEPRECATED);


@nicolas-grekas worth mentioning this only applies to outlined anon. services (top level, non-inlined... how should we call that?)

Top-level anonymous services... then?

xabbuh · 2017-05-25T08:13:45Z

UPGRADE-3.4.md

@@ -11,5 +16,5 @@ Finder
 Validator
 ---------

- * not setting the `strict` option of the `Choice` constraint to `true` is
+ * Not setting the `strict` option of the `Choice` constraint to `true` is


should IMO be reverted as the sentence does not end with a dot

xabbuh · 2017-05-25T08:15:07Z

Do we still have a test which ensures that deprecations are not triggered for nested anonymous definitions?

ro0NL · 2017-05-25T08:16:17Z

Yep :) https://github.com/symfony/symfony/pull/22903/files#diff-25d0b562ad1c177bac8f4f9d0247b2acR7

it's tricky though due loose comparison of deprecations; if it triggered we wouldnt catch it (before it did by including the no. of occurences)

xabbuh · 2017-05-25T08:19:35Z

@ro0NL But this one is only tested in a @legacy test. So we would never notice when it accidentally triggered a deprecation.

xabbuh · 2017-05-25T08:24:45Z

src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php

@@ -230,6 +230,17 @@ public function testLoadAnonymousServices()
        $this->assertSame($fooArgs[0], $barArgs[0]);
    }

+    /**
+     * @group legacy
+     * @expectedDeprecation Top-level anonymous services are deprecated since Symfony 3.4, the "id" attribute will be required in version 4.0 in %sservices_without_id.xml.


the %s seems to be a left-over from the sprintf pattern

it includes an absolute path, so this deals with phpunit's assertStringMatchesFormat

xabbuh · 2017-05-25T08:38:48Z

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

@@ -412,6 +412,10 @@ private function processAnonymousServices(\DOMDocument $xml, $file, $defaults)

        // anonymous services "in the wild"
        if (false !== $nodes = $xpath->query('//container:services/container:service[not(@id)]')) {
+            if ($nodes->length) {
+                @trigger_error(sprintf('Top-level anonymous services are deprecated since Symfony 3.4, the "id" attribute will be required in version 4.0 in %s.', $file), E_USER_DEPRECATED);


maybe we should include the class in the deprecation message to make it easier to find the place

currently it triggers one deprecation per file, kinda like that; it goes away after you solved everything. Also class can be empty... not helping :)

updated thanks to https://secure.php.net/manual/en/domnode.getlineno.php

ro0NL · 2017-05-25T08:51:03Z

@xabbuh extra test added

fabpot · 2017-05-25T23:22:49Z

Thank you @ro0NL.

This PR was merged into the 3.4 branch. Discussion ---------- [DI] Deprecate XML services without ID | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no, confusing though | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  On slack someone had a issue with class named services; > So, probably should have done this sooner, I stepped through with a debugger and it looks like \Symfony\Component\DependencyInjection\Loader\XmlFileLoader::processAnonymousServices assigns a sha256 to services that don't have any IDs > When my manually wired service is registered, it has an ID that looks like 1_344b468f6069ffe8c32092409d99c59abc218f41071ce4c4230c198876129bc0, so it doesn't override the auto-loaded one > I swear I read that IDs default to the class name now... The fix was easy; doing `<service id="ClassName"/>` instead of `<service class="ClassName"/>`. However the thing is... i made the exact same mistake trying to reproduce 😅 I think given the recent developments (dropping type based autowiring and class named services) it makes sense to force XML service to specify an ID attribute (the top level ones). This would be consistent with YAML and PHP as well. Fixing deprecations is also easy, just change `class` attribute to `id` like i've done for the frameworkbundle in this PR. Any thoughts? Commits ------- b8c68da [DI] Deprecate XML services without ID

backbone87 · 2017-06-24T13:42:42Z

Is it possible to allow unnamed toplevel services, which will be implicitly named after the class name?
So that <service class="Foo"> will generate a service of class Foo named Foo?
Imho the current behavior is quite counter intuitive since one expect with an unnamed toplevel service to be implicitly assigned the class name. If there are multiple unnamed top level services an error should be thrown during compilation.

carsonbot added Status: Needs Review DependencyInjection Feature Deprecation labels May 25, 2017

nicolas-grekas added this to the 3.4 milestone May 25, 2017

nicolas-grekas approved these changes May 25, 2017

View reviewed changes

ro0NL commented May 25, 2017

View reviewed changes

nicolas-grekas changed the base branch from master to 3.4 May 25, 2017 08:02

xabbuh reviewed May 25, 2017

View reviewed changes

xabbuh approved these changes May 25, 2017

View reviewed changes

xabbuh added Status: Reviewed and removed Status: Needs Review labels May 25, 2017

ogizanagi approved these changes May 25, 2017

View reviewed changes

[DI] Deprecate XML services without ID

b8c68da

fabpot merged commit b8c68da into symfony:3.4 May 25, 2017

ro0NL deleted the di/xml-service branch May 26, 2017 07:13

This was referenced Oct 18, 2017

Release v3.4.0-BETA1 #24609

Merged

Release v4.0.0-BETA1 #24612

Merged

nicolas-grekas mentioned this pull request Dec 10, 2017

[DependencyInjection] Anonymous services in PHP DSL #24632

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI] Deprecate XML services without ID #22903

[DI] Deprecate XML services without ID #22903

ro0NL commented May 25, 2017

nicolas-grekas left a comment •

edited

Loading

nicolas-grekas May 25, 2017

ro0NL May 25, 2017

ro0NL commented May 25, 2017

ro0NL May 25, 2017

nicolas-grekas May 25, 2017

xabbuh May 25, 2017

xabbuh commented May 25, 2017

ro0NL commented May 25, 2017 •

edited

Loading

xabbuh commented May 25, 2017

xabbuh May 25, 2017 •

edited

Loading

ro0NL May 25, 2017

xabbuh May 25, 2017

ro0NL May 25, 2017

ro0NL May 25, 2017

ro0NL commented May 25, 2017

fabpot commented May 25, 2017

backbone87 commented Jun 24, 2017

[DI] Deprecate XML services without ID #22903

[DI] Deprecate XML services without ID #22903

Conversation

ro0NL commented May 25, 2017

nicolas-grekas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL commented May 25, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented May 25, 2017

ro0NL commented May 25, 2017 • edited Loading

xabbuh commented May 25, 2017

xabbuh May 25, 2017 • edited Loading

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

ro0NL commented May 25, 2017

fabpot commented May 25, 2017

backbone87 commented Jun 24, 2017

nicolas-grekas left a comment •

edited

Loading

ro0NL commented May 25, 2017 •

edited

Loading

xabbuh May 25, 2017 •

edited

Loading