[DI] Added support for deprecating aliases #29968

renanbr · 2019-01-23T16:31:46Z

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

This PR is a continuity of #24707

stof

This also seems to miss warning (at compile-time) when a service is referencing a deprecated alias (before resolving them, otherwise we won't have any such reference)

stof · 2019-01-23T16:33:34Z

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

                    throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for the service "%s" which is defined as an alias in "%s". Allowed configuration keys for service aliases are "alias" and "public".', $key, $id, $file));
+                    continue;


this continue is dead code

OskarStark · 2019-01-24T07:25:42Z

src/Symfony/Component/DependencyInjection/Alias.php

+     * Whether this alias is deprecated, that means it should not be called
+     * anymore.
+     *
+     * @param bool   $status   Defaults to true


the description should describe what it does

nicolas-grekas

I think we're good thank you!
Here are some minor comments.
Please squash all your commits also keep only two.

nicolas-grekas · 2019-01-24T16:34:35Z

src/Symfony/Component/DependencyInjection/Alias.php

@@ -78,6 +85,58 @@ public function isPrivate()
        return $this->private;
    }

+    /**
+     * Whether this alias is deprecated, that means it should not be called


s/called/referenced

nicolas-grekas · 2019-01-24T16:36:34Z

src/Symfony/Component/DependencyInjection/Alias.php

+    /**
+     * Returns whether this alias is deprecated.
+     *
+     * @return bool


the whole docblock can be removed and replaced by a real return type

nicolas-grekas · 2019-01-24T16:36:54Z

src/Symfony/Component/DependencyInjection/Alias.php

+     *
+     * @return string
+     */
+    public function getDeprecationMessage($id)


should use real argument+return type + remove docblock

nicolas-grekas · 2019-01-24T16:52:34Z

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

@@ -667,8 +671,12 @@ private function validateAlias(\DOMElement $alias, $file)
            }
        }

+        $allowedTags = ['deprecated'];


no need for the temporary variable, isn't it? better remove it.

nicolas-grekas · 2019-01-24T16:54:25Z

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

+    {
+        $container = new ContainerBuilder();
+
+        $container->register('foo', '\stdClass');


no need for the \ (same below)

nicolas-grekas · 2019-01-24T16:55:07Z

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

+
+        $aliasDeprecated = new Alias('foo');
+        $aliasDeprecated->setDeprecated(true);
+        $container->setAlias('foo_aliased', $aliasDeprecated);


maybe name it deprecated_foo_alias instead of foo_aliased?

nicolas-grekas · 2019-01-24T16:56:08Z

src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php

+
+        $dumper = new PhpDumper($container);
+        $this->assertStringEqualsFile(self::$fixturesPath.'/php/container_alias_deprecation.php', $dumper->dump());
+        eval('?>'.$dumper->dump(['class' => 'Symfony_DI_PhpDumper_Test_Aliases_Deprecation']));


better dump only once (see previous line)

nicolas-grekas · 2019-01-24T17:00:12Z

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/container_alias_deprecation.php

+    /**
+     * Gets the public 'alias_for_foo_deprecated' alias.
+     *
+     * @return object An instance returned by "getFooService()"


Maybe this message should be The "foo" service.?

renanbr · 2019-01-24T18:02:00Z

changes applied, commits squashed
@stof, @OskarStark, @nicolas-grekas

nicolas-grekas · 2019-01-24T18:26:08Z

Fabbot complains :)

nicolas-grekas · 2019-01-25T09:58:00Z

Thank you @renanbr.

This PR was merged into the 4.3-dev branch. Discussion ---------- [DI] Added support for deprecating aliases | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? |no | Tests pass? | yes | Fixed tickets | #24507 | License | MIT | Doc PR | TBD This PR is a continuity of #24707 Commits ------- 6c571ad Added support for deprecating aliases (runtime+dumper) 0eb071b Added support for deprecating an alias

nicolas-grekas · 2019-01-25T09:58:45Z

And thank you @j92 !

javiereguiluz · 2019-01-28T15:48:08Z

src/Symfony/Component/DependencyInjection/Alias.php

+    private $deprecated;
+    private $deprecationTemplate;
+
+    private static $defaultDeprecationTemplate = 'The "%service_id%" service alias is deprecated. You should stop using it, as it will soon be removed.';


I know this PR is merged, but I've just reviewed its code and I wondered if the %service_id% placeholder name is confusing to other people too. To me, this placeholder would be easier to understand if it was called %alias_id%.

Also, this -> ... as it will soon be removed. could be -> ... as it will be removed in the future.

Thanks.

updated in #29995, please review

… is found (nicolas-grekas) This PR was merged into the 4.3-dev branch. Discussion ---------- [DI] add id of referencing service when a deprecated alias is found | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Improves #29968 a bit for DX. Commits ------- b124fb7 [DI] add id of referencing service when a deprecated alias is found

…iluz) This PR was squashed before being merged into the master branch (closes #10937). Discussion ---------- Documented the deprecation of service aliases It documents symfony/symfony#29968 but it contains the changes of the pending PR symfony/symfony#29995 Commits ------- d5d87e6 Documented the deprecation of service aliases

…ebug:autowiring | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | n/a Fix and improves a bit PR symfony#29968 and symfony#29995

…ed aliases in debug:autowiring (XuruDragon) This PR was merged into the 4.3-dev branch. Discussion ---------- [DependencyInjection] Added information about deprecated aliases in debug:autowiring | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | n/a Fix and improves a bit PR #29968 and #29995 ![Screenshot](https://i.imgur.com/GDj2NIY.png) Commits ------- 3d2378d [DependencyInjection] Added information about deprecated aliases in debug:autowiring

Added support for deprecating an alias

0eb071b

nicolas-grekas added this to the next milestone Jan 23, 2019

stof requested changes Jan 23, 2019

View reviewed changes

carsonbot added the Status: Needs Work label Jan 23, 2019

OskarStark requested changes Jan 24, 2019

View reviewed changes

nicolas-grekas approved these changes Jan 24, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Jan 24, 2019

nicolas-grekas mentioned this pull request Jan 24, 2019

Added support for deprecating aliases #24707

Closed

nicolas-grekas changed the title ~~Added support for deprecating aliases~~ [DI] Added support for deprecating aliases Jan 24, 2019

Added support for deprecating aliases (runtime+dumper)

6c571ad

nicolas-grekas merged commit 6c571ad into symfony:master Jan 25, 2019

renanbr deleted the deprecate-aliases branch January 25, 2019 10:23

xabbuh mentioned this pull request Jan 26, 2019

[DependencyInjection] fix DOM element namespace URL access #29992

Merged

nicolas-grekas mentioned this pull request Jan 26, 2019

[DI] add id of referencing service when a deprecated alias is found #29995

Merged

javiereguiluz reviewed Jan 28, 2019

View reviewed changes

javiereguiluz mentioned this pull request Jan 28, 2019

Documented the deprecation of service aliases symfony/symfony-docs#10937

Closed

XuruDragon mentioned this pull request Feb 4, 2019

[DependencyInjection] Added information about deprecated aliases in debug:autowiring #30075

Merged

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

javiereguiluz mentioned this pull request Sep 21, 2019

Ability to deprecate aliases #24507

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI] Added support for deprecating aliases #29968

[DI] Added support for deprecating aliases #29968

renanbr commented Jan 23, 2019

stof left a comment

stof Jan 23, 2019

OskarStark Jan 24, 2019

nicolas-grekas left a comment

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

nicolas-grekas Jan 24, 2019

renanbr commented Jan 24, 2019

nicolas-grekas commented Jan 24, 2019

nicolas-grekas commented Jan 25, 2019

nicolas-grekas commented Jan 25, 2019

javiereguiluz Jan 28, 2019

nicolas-grekas Jan 28, 2019

		throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for the service "%s" which is defined as an alias in "%s". Allowed configuration keys for service aliases are "alias" and "public".', $key, $id, $file));
		continue;

[DI] Added support for deprecating aliases #29968

[DI] Added support for deprecating aliases #29968

Conversation

renanbr commented Jan 23, 2019

stof left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a 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

renanbr commented Jan 24, 2019

nicolas-grekas commented Jan 24, 2019

nicolas-grekas commented Jan 25, 2019

nicolas-grekas commented Jan 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment