[DependencyInjection] Improve ServiceLocatorTagPass service matching #28571

codedmonkey · 2018-09-23T20:01:19Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#26892
License	MIT
Doc PR	symfony/symfony-docs#10397

Allows omitting of keys for service locator arguments (it will automatically take over the original definition alias).

nicolas-grekas

thanks, do you think you could add some tests please?

nicolas-grekas · 2018-09-23T20:25:44Z

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

        }

        foreach ($arguments[0] as $k => $v) {
            if ($v instanceof ServiceClosureArgument) {
                continue;
            }
+
+            if (\is_string($type = $v) && preg_match('/^\??[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)*+$/', $type)) {


this will allow <argument>Psr\Logger\LoggerInterface</argument>
alongside with <argument type="service" id="Psr\Logger\LoggerInterface" />
I read too fast this part of your proposal. I think it's not a good idea. It would create an inconsistency in the way the configuration works.
But being able to omit the "key" part looks like a good idea to me.

nicolas-grekas · 2018-09-24T08:20:37Z

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

+            }
+
+            if (\is_int($k)) {
+                unset($arguments[0][$k]);


I'd suggest moving "unset" outside of the "if": that will allow preserving the order in the list

I agree but right after the for loop it does a ksort so I presume that's unnecessary.

I forgot about it, no need then. Thanks.

chalasr · 2018-09-25T09:22:20Z

src/Symfony/Component/DependencyInjection/Tests/Compiler/ServiceLocatorTagPassTest.php

+
+        $this->assertEquals(CustomDefinition::class, \get_class($locator('bar')));
+        $this->assertEquals(CustomDefinition::class, \get_class($locator('baz')));
+        $this->assertEquals(CustomDefinition::class, \get_class($locator('some.service')));


assertSame

stof · 2018-09-25T12:41:18Z

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

+            if (\is_int($k)) {
+                unset($arguments[0][$k]);
+
+                $k = (string) $v;


should we check whether this key already exists in the configured arguments ?

I'm not sure: if the key exists after the numbered one, it will override it - and if it came before, then the numbered one should win to me. works for you also?

nope, it will always override it here. If it comes after the numbered one, processing it will see the value set by the processing of the numbered one, not the original one, as it would have been replaced

Really? foreach operates on a copy of array so that it will yield the original value at this iteration, and overwrite the value set by the numbered step to me.

Added some basic tests that should confirm @nicolas-grekas description. I do like the idea of preventing unexepected behavior for the user but it works either way for me.

nicolas-grekas · 2018-09-27T17:52:02Z

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

+                $k = (string) $v;
+
+                if (isset($arguments[0][$k])) {
+                    throw new InvalidArgumentException(sprintf('Invalid definition for service "%s": service key "%s" cannot be inherited from the service definition because the key already exists.', $this->currentId, $k));


Per my comments above, I'm not sure about this. It should be removed to me.

(but please add tests showing that the later wins over the former if you can, that'll help prove who is right here :) )

Fine by me if all differences have been set aside. I've checked how the different configuration formats handled duplicate declarations and they don't seem work the same at all, so there doesn't seem to be a best way.

Can you elaborate? What's the difference you spotted?
If we want to keep the exception (I'm fine with it also), I'd suggest a message like:
`Invalid service locator definition for "%s": key "%s" is defined twice.', $this->currentId, $k));

Here's my examples:

// PHP - Result: service_b ->setArguments([[ 'service_a' => new Reference('service_a'), 'service_a' => new Reference('service_b'), ]]) // YAML - Result: service_a arguments: - service_a: '@service_a' service_a: '@service_b' // XML - Result: service_b <argument type="collection"> <argument type="service" id="service_a" key="service_a" /> <argument type="service" id="service_b" key="service_a" /> </argument>

Not that how PHP handles duplicate array keys matters a lot, just thought it might give a direction for the right solution.

nicolas-grekas · 2018-09-30T17:53:59Z

Thanks for the update. Can you add a test case that throws the new exception please?

codedmonkey · 2018-10-01T14:34:30Z

I removed the additional exception if that's all right with you?

nicolas-grekas · 2018-10-03T07:27:30Z

Thank you @codedmonkey.

…rvice matching (codedmonkey) This PR was squashed before being merged into the 4.2-dev branch (closes #28571). Discussion ---------- [DependencyInjection] Improve ServiceLocatorTagPass service matching | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #26892 | License | MIT | Doc PR | symfony/symfony-docs#10397 Allows omitting of keys for service locator arguments (it will automatically take over the original definition alias). Commits ------- 1c1210a [DependencyInjection] Improve ServiceLocatorTagPass service matching

…tor changes (codedmonkey, javiereguiluz) This PR was submitted for the master branch but it was merged into the 4.3 branch instead (closes #10397). Discussion ---------- [DependencyInjection] Add documentation for service locator changes Adds documentation for PR symfony/symfony#28571 Commits ------- 8d8c65e Reword bc5ef85 [DependencyInjection] Add documentation for service locator changes

carsonbot added Status: Needs Review DependencyInjection Feature labels Sep 23, 2018

codedmonkey force-pushed the service-locator branch 2 times, most recently from 831ebf6 to e58293b Compare September 23, 2018 20:11

nicolas-grekas reviewed Sep 23, 2018

View reviewed changes

nicolas-grekas reviewed Sep 24, 2018

View reviewed changes

nicolas-grekas added this to the next milestone Sep 24, 2018

codedmonkey force-pushed the service-locator branch 2 times, most recently from 0357dc0 to 55e1075 Compare September 24, 2018 19:13

codedmonkey mentioned this pull request Sep 24, 2018

[DependencyInjection] Add documentation for service locator changes symfony/symfony-docs#10397

Merged

chalasr reviewed Sep 25, 2018

View reviewed changes

chalasr approved these changes Sep 25, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 25, 2018

stof reviewed Sep 25, 2018

View reviewed changes

codedmonkey force-pushed the service-locator branch from a467c0a to d44c37f Compare September 27, 2018 09:58

nicolas-grekas reviewed Sep 27, 2018

View reviewed changes

codedmonkey force-pushed the service-locator branch from d44c37f to 2d6050e Compare September 30, 2018 17:10

nicolas-grekas approved these changes Oct 1, 2018

View reviewed changes

[DependencyInjection] Improve ServiceLocatorTagPass service matching

1c1210a

nicolas-grekas force-pushed the service-locator branch from 2d6050e to 1c1210a Compare October 3, 2018 07:27

nicolas-grekas merged commit 1c1210a into symfony:master Oct 3, 2018

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

fabpot mentioned this pull request Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

fabpot mentioned this pull request Nov 3, 2018

Release v4.2.0-BETA1 #29073

Merged

codedmonkey deleted the service-locator branch December 14, 2018 23:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Improve ServiceLocatorTagPass service matching #28571

[DependencyInjection] Improve ServiceLocatorTagPass service matching #28571

codedmonkey commented Sep 23, 2018 •

edited

Loading

nicolas-grekas left a comment

nicolas-grekas Sep 23, 2018 •

edited

Loading

nicolas-grekas Sep 24, 2018 •

edited

Loading

codedmonkey Sep 24, 2018

nicolas-grekas Sep 24, 2018

chalasr Sep 25, 2018

stof Sep 25, 2018

nicolas-grekas Sep 25, 2018

stof Sep 27, 2018

nicolas-grekas Sep 27, 2018

codedmonkey Sep 30, 2018

nicolas-grekas Sep 27, 2018

nicolas-grekas Sep 27, 2018

codedmonkey Sep 27, 2018

nicolas-grekas Sep 29, 2018

codedmonkey Sep 30, 2018

nicolas-grekas commented Sep 30, 2018

codedmonkey commented Oct 1, 2018

nicolas-grekas commented Oct 3, 2018

[DependencyInjection] Improve ServiceLocatorTagPass service matching #28571

[DependencyInjection] Improve ServiceLocatorTagPass service matching #28571

Conversation

codedmonkey commented Sep 23, 2018 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas Sep 23, 2018 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas Sep 24, 2018 • 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Sep 30, 2018

codedmonkey commented Oct 1, 2018

nicolas-grekas commented Oct 3, 2018

codedmonkey commented Sep 23, 2018 •

edited

Loading

nicolas-grekas Sep 23, 2018 •

edited

Loading

nicolas-grekas Sep 24, 2018 •

edited

Loading