[DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. #17133

hhamon · 2015-12-24T15:18:59Z

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

Merry Christmas Symfony!!!

hhamon · 2015-12-24T15:21:28Z

To me this PR should be opened against the 2.3, 2.7, 2.8 and 3.0 branches as this behavior is already supported by the XmlFileLoader thanks to the provided XML definition file.

Should we consider it a new feature and keep the PR opened against the master branch or should I reopen it against the older branches?

@nicolas-grekas @stof @fabpot any ideas please?

dunglas · 2015-12-25T21:38:10Z

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

+    private static function checkDefinition($id, array $definition)
+    {
+        foreach ($definition as $key => $value) {
+            if (!in_array($key, static::$keywords)) {


You can make supported properties keys of static::$keywords and use isset, it will reduce the complexity from O(n) to O(1).

nicolas-grekas · 2015-12-28T12:17:40Z

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

+            if (!isset(static::$keywords[$key])) {
+                throw new InvalidArgumentException(sprintf(
+                    'The "%s" key in "%s" service definition is not valid. It must be one of "%s".',
+                    (string) $key,


no need to cast here, and usually, we prefer putting exceptions on one single (long) line

stof · 2015-12-28T12:56:23Z

The problem is when you have a generic bundle that supports "symfony/symfony": "^2.3|^3.0", a solution to support the new api is to have the new and the deprecated keywords in its configuration files.
This PR would force people to update their package in a minor version and it is against the symfony BC policy. IMO this exception should be added in symfony 4.0 and unsupported keywords deprecated in symfony 3.1.

I agree with @Ener-Getick here. Throwing an exception on unsupported keys in the service definition is indeed a BC break as it might break existing working config files.

hhamon · 2015-12-28T16:17:52Z

I've changed the PR to raise a deprecation notice instead. Shall we also introduce an UPGRADE-4.0.md to start indexing the future changes in 4.x?

GuilhemN · 2015-12-28T16:28:16Z

I think that we should have an upgrade file for 3.1 which would advise to don't use unsupported keys anymore.

hhamon · 2015-12-28T16:46:51Z

I guess this time, it's ok for another round of review.

GuilhemN · 2015-12-28T16:51:57Z

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

@@ -32,6 +32,30 @@
 */
 class YamlFileLoader extends FileLoader
 {
+    private static $keywords = array(
+        'alias' => 'alias',
+        'parent' => 'parent',


What about removing this array values as the code only uses its keys?
Ping @dunglas

values are used when constructing the message (see implode)

Oops didn't see that ☺️

…if a service definition contains unsupported keywords.

nicolas-grekas · 2015-12-29T09:53:20Z

👍

xabbuh · 2015-12-29T10:03:12Z

We should add a way to add additional custom keys. For example, the FOSRestBundle adds additional keys for defining REST related routes. With the current implementation we would have overridde the complete checkDefinition() method.

hhamon · 2015-12-29T10:05:07Z

@xabbuh it's for service definitions routing. Does FOSRestBundle have extra parameters for services definitions?

xabbuh · 2015-12-29T10:11:28Z

@hhamon Sorry, forget about my comment.

hhamon · 2016-01-05T10:01:00Z

Any news on this? @xabbuh @stof @nicolas-grekas @dunglas @weaverryan @webmozart

dunglas · 2016-01-05T10:08:21Z

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

+                // @deprecated Uncomment the following statement in Symfony 4.0
+                // and also update the corresponding unit test to make it expect
+                // an InvalidArgumentException exception.
+                //throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for service definition "%s" in "%s". Allowed configuration keys are "%s".', $key, $id, $file, implode('", "', static::$keywords)));


What about creating the 4.0 branch now to avoid having to make such updates later?

👍 would avoid to forget some deprecations/updates of the code.

I'm 100% for creating for 4.0 branch already if @fabpot agrees.

As one of the happy few doing the merges from 2.3 up to master, I'm 👎. This is tedious enough to not add one more branch. I hope you understand...

@nicolas-grekas this branch would not need to have merges as often as the others and should also not receive as much commits

The drawback would be that we would have to maintain it already, and people would start using it in their composer projects. So I'm -1 on it.

When we start the 4.0 development, we will look at any existing @trigger_error to convert them to the new code (either removing code, or doing other actions).

I would even remove the commented exception and just put a comment saying it should be converted to an exception in 4.0. This way, the exception message will be written at the 4.0 time, not now, and so using the uptodate deprecation message.

Thus, merges into newer major versions are the worse branch merges, as they often trigger merge conflicts (due to the removal of BC layers), so it is better to avoid doing them during the whole 3.x lifetime.

Oh, and creating 4.0 would require creating 3.1, 3.2, 3.3 and 3.4 also, because that's how we merge things. 👎 👎 👎

dunglas · 2016-01-05T10:09:10Z

👍, very useful when using autowiring (I often use the key types instead and autowiring_types and currently it silently fail).

xabbuh · 2016-01-05T19:11:43Z

👍

fabpot · 2016-01-07T13:30:43Z

Thank you @hhamon.

…ecation notice if a service definition contains unsupported keywords. (hhamon) This PR was merged into the 3.1-dev branch. Discussion ---------- [DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Merry Christmas Symfony!!! Commits ------- bb5f118 [DependencyInjection] make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords.

…/elements for alias (Ener-Getick) This PR was squashed before being merged into the 3.1-dev branch (closes #17323). Discussion ---------- [DependencyInjection] Deprecate unsupported attributes/elements for alias | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #17256 | License | MIT Following #17133, this PR deprecates using unsupported keywords on alias definition. For example the following examples will trigger deprecations: ```xml <?xml version="1.0" encoding="utf-8"?> <container> <services> <service id="bar" alias="foo" class="Foo"> <tag name="foo.bar" /> </service> </services> </container> ``` ```yml services: bar: alias: foo parent: quz ``` Commits ------- 49eb65c [DependencyInjection] Deprecate unsupported attributes/elements for alias

…/elements for alias (Ener-Getick) This PR was squashed before being merged into the 3.1-dev branch (closes #17323). Discussion ---------- [DependencyInjection] Deprecate unsupported attributes/elements for alias | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #17256 | License | MIT Following symfony/symfony#17133, this PR deprecates using unsupported keywords on alias definition. For example the following examples will trigger deprecations: ```xml <?xml version="1.0" encoding="utf-8"?> <container> <services> <service id="bar" alias="foo" class="Foo"> <tag name="foo.bar" /> </service> </services> </container> ``` ```yml services: bar: alias: foo parent: quz ``` Commits ------- 49eb65c [DependencyInjection] Deprecate unsupported attributes/elements for alias

carsonbot added the Status: Needs Review label Dec 24, 2015

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch from 97d979b to 505089b Compare December 24, 2015 15:22

dunglas reviewed Dec 25, 2015
View reviewed changes

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch from 505089b to 188ab3b Compare December 27, 2015 12:40

nicolas-grekas reviewed Dec 28, 2015
View reviewed changes

hhamon changed the title ~~[DependencyInjection] Make YamlFileLoader raise an InvalidArgumentException if a service definition contains unsupported keywords.~~ [DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. Dec 28, 2015

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch 2 times, most recently from 898e9b8 to 4a3ab07 Compare December 28, 2015 16:26

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch 4 times, most recently from 31a98fc to 6f398da Compare December 28, 2015 16:45

GuilhemN reviewed Dec 28, 2015
View reviewed changes

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch 3 times, most recently from 54ea34c to 4a67241 Compare December 29, 2015 09:35

[DependencyInjection] make YamlFileLoader raise a deprecation notice …

bb5f118

…if a service definition contains unsupported keywords.

hhamon force-pushed the feat-raise-exception-invalid-yaml-definition branch from 4a67241 to bb5f118 Compare December 29, 2015 09:37

dunglas reviewed Jan 5, 2016
View reviewed changes

fabpot merged commit bb5f118 into symfony:master Jan 7, 2016

GuilhemN mentioned this pull request Jan 9, 2016

[DependencyInjection] Deprecate unsupported attributes/elements for alias #17323

Closed

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. #17133

[DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. #17133

hhamon commented Dec 24, 2015

hhamon commented Dec 24, 2015

dunglas Dec 25, 2015

hhamon Dec 27, 2015

nicolas-grekas Dec 28, 2015

stof commented Dec 28, 2015

hhamon commented Dec 28, 2015

GuilhemN commented Dec 28, 2015

hhamon commented Dec 28, 2015

GuilhemN Dec 28, 2015

nicolas-grekas Dec 29, 2015

GuilhemN Dec 29, 2015

nicolas-grekas commented Dec 29, 2015

xabbuh commented Dec 29, 2015

hhamon commented Dec 29, 2015

xabbuh commented Dec 29, 2015

hhamon commented Jan 5, 2016

dunglas Jan 5, 2016

GuilhemN Jan 5, 2016

hhamon Jan 5, 2016

nicolas-grekas Jan 5, 2016

GuilhemN Jan 5, 2016

stof Jan 5, 2016

stof Jan 5, 2016

nicolas-grekas Jan 5, 2016

dunglas commented Jan 5, 2016

xabbuh commented Jan 5, 2016

fabpot commented Jan 7, 2016

[DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. #17133

[DependencyInjection] Make YamlFileLoader raise a deprecation notice if a service definition contains unsupported keywords. #17133

Conversation

hhamon commented Dec 24, 2015

hhamon commented Dec 24, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Dec 28, 2015

hhamon commented Dec 28, 2015

GuilhemN commented Dec 28, 2015

hhamon commented Dec 28, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 29, 2015

xabbuh commented Dec 29, 2015

hhamon commented Dec 29, 2015

xabbuh commented Dec 29, 2015

hhamon commented Jan 5, 2016

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

dunglas commented Jan 5, 2016

xabbuh commented Jan 5, 2016

fabpot commented Jan 7, 2016