[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output #46814

94noni · 2022-06-30T12:15:37Z

Q	A
Branch?	6.2
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	.
License	MIT
Doc PR	.

Hi, the debug:container is great to understand container's services in the app

Having this deprecated warning can be valuable in such debug context, that is why I propose to add this on the output

For ex with such definition:

        ->set('url_helper', UrlHelper::class)
            ->args([
                service('request_stack'),
                service('router.request_context')->ignoreOnInvalid(),
            ])
            ->deprecate('symfony/framework-bundle', '6.2', 'The service "%service_id% is deprecated. Use "FooBarService" instead.')
        ->alias(UrlHelper::class, 'url_helper')
            ->deprecate('symfony/framework-bundle', '6.2', 'The alias "%alias_id% is deprecated. Use "FooBarAlias" instead.')

ogizanagi · 2022-07-03T13:34:49Z

What about showing the deprecation message as well?
Regarding the txt output, this could even be shown in a warning block.

94noni · 2022-07-03T18:08:45Z

@ogizanagi it could indeed be a nice idea!

But as there are lot of test files to update, I would prefer asking first a consensus before doing the proposed change if you dont mind :)

GromNaN

That's a very useful information. I like the idea of colored warning in case of depreciation.

src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_priority_tag.xml

94noni · 2022-07-04T06:08:46Z

@GromNaN @ogizanagi oki, I will try adding the deprecated message, and a colored output for when applicable

94noni · 2022-07-04T08:20:31Z

With new code changes, I can get such results (with faking a service deprecation)

ogizanagi · 2022-07-04T12:21:12Z

@94noni : Sorry to make you change this again, I should have been clearer:
what about removing the info from the table output to show the deprecation message if the service is deprecated, using $io->warning() at the end of the command output?

94noni · 2022-07-04T21:08:49Z

@ogizanagi hey, do you mean like in my screenshot and written above the ! [Note] but as warning?

if yes I can rework as requested :)

ogizanagi · 2022-07-04T21:14:39Z

@94noni : exactly what I meant :)

94noni · 2022-07-05T09:21:48Z

@ogizanagi @GromNaN PR reworked and description updated based on addressed comments :)

chalasr · 2022-07-05T09:30:57Z

Looks good to me. Can you please go ahead with the missing test(s)?

94noni · 2022-07-05T09:46:01Z

@chalasr The only failed test I can see in the above checks is about 1) Symfony\Component\VarDumper\Tests\Server\ConnectionTest::testDump seem unrelated isn't it?

src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php

chalasr · 2022-07-05T10:52:03Z

What I mean is that this feature should be covered by a test if possible

94noni · 2022-07-06T15:09:01Z

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml

+    deprecated:
+        class: Symfony\Bundle\FrameworkBundle\Tests\Fixtures\DeprecatedClass
+        deprecated: The "%service_id%" service is deprecated since foo/bar 1.9 and will be removed in 2.0. Use "public" service instead.
+    deprecated_alias:


94noni · 2022-07-06T15:09:15Z

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml

@@ -11,6 +11,15 @@ services:
    private_alias:
        alias: public
        public: false
+    deprecated:


cf doc + PR

94noni · 2022-07-08T08:12:16Z

status: needs review

This PR was submitted for the 6.0 branch but it was merged into the 5.4 branch instead. Discussion ---------- Fix doc service deprecation Hi, Based on [this PR](symfony/symfony#46814), I've followed [the doc](https://symfony.com/doc/current/service_container/alias_private.html#deprecating-services) But when tests executed, I got [this error](symfony/symfony#46814 (comment)) So I propose to fix the doc accordingly here Thank you Commits ------- ffdb7e6 Fix documentation on declaration of service deprecation in YAML format

94noni · 2022-07-18T19:30:09Z

With #38903 being recently merged there are lot of conflicts
May I ask from reviewers another round of reviews on the core code, before taking time to fix all tests conflicts?
thanks :)

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

fabpot · 2022-07-20T20:12:51Z

@94noni Can you rebase this PR to get rid of the merge commit (that prevents me from merging this PR)?

94noni · 2022-07-20T20:41:32Z

@fabpot I'll handle this very soon and ping back

…container <name> output

fabpot · 2022-07-21T11:35:06Z

Thank you @94noni.

carsonbot added Status: Needs Review Feature FrameworkBundle labels Jun 30, 2022

carsonbot added this to the 6.2 milestone Jun 30, 2022

94noni force-pushed the debug-container-deprecated branch from f68d488 to 4afa6c5 Compare June 30, 2022 13:38

This comment was marked as outdated.

Sign in to view

GromNaN reviewed Jul 3, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_priority_tag.xml Show resolved Hide resolved

94noni force-pushed the debug-container-deprecated branch 4 times, most recently from f4ac1a4 to 32562a8 Compare July 4, 2022 08:18

94noni force-pushed the debug-container-deprecated branch 2 times, most recently from 8e2d3cd to 6a30629 Compare July 5, 2022 08:43

stof requested changes Jul 5, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jul 5, 2022

94noni commented Jul 6, 2022

View reviewed changes

94noni force-pushed the debug-container-deprecated branch from cf6e55d to e9a5d5c Compare July 6, 2022 15:21

94noni mentioned this pull request Jul 8, 2022

Fix doc service deprecation symfony/symfony-docs#16952

Merged

94noni force-pushed the debug-container-deprecated branch 6 times, most recently from 4bb7984 to 0f69408 Compare July 8, 2022 08:00

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 8, 2022

94noni mentioned this pull request Jul 13, 2022

[FrameworkBundle] Add "Usages" to debug:container output #38903

Merged

ogizanagi reviewed Jul 18, 2022

View reviewed changes

fabpot approved these changes Jul 20, 2022

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jul 20, 2022

94noni force-pushed the debug-container-deprecated branch 2 times, most recently from eb6b62e to 5a93272 Compare July 21, 2022 06:58

94noni changed the title ~~[FrameworkBundle] Add service deprecation on debug:container command output~~ [FrameworkBundle] Add service and alias deprecation message to debug:container <name> output Jul 21, 2022

[FrameworkBundle] Add service and alias deprecation message to debug:…

82054bc

…container <name> output

94noni force-pushed the debug-container-deprecated branch from 5a93272 to 82054bc Compare July 21, 2022 07:34

fabpot merged commit c7d7ce9 into symfony:6.2 Jul 21, 2022

fabpot mentioned this pull request Jul 21, 2022

[FrameworkBundle] Add service and alias deprecation message to debug:co… symfony/symfony-docs#17026

Closed

94noni deleted the debug-container-deprecated branch July 21, 2022 11:40

fabpot mentioned this pull request Oct 24, 2022

Release v6.2.0-BETA1 #47972

Merged

94noni mentioned this pull request Apr 2, 2024

[FrameworkBundle] Display aliases in debug:container command #54459

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output #46814

[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output #46814

94noni commented Jun 30, 2022 •

edited

This comment was marked as outdated.

ogizanagi commented Jul 3, 2022

94noni commented Jul 3, 2022

GromNaN left a comment

94noni commented Jul 4, 2022

94noni commented Jul 4, 2022

ogizanagi commented Jul 4, 2022 •

edited

94noni commented Jul 4, 2022

ogizanagi commented Jul 4, 2022

94noni commented Jul 5, 2022

chalasr commented Jul 5, 2022

94noni commented Jul 5, 2022

chalasr commented Jul 5, 2022

94noni Jul 6, 2022

94noni Jul 6, 2022 •

edited

94noni commented Jul 8, 2022

94noni commented Jul 18, 2022

fabpot commented Jul 20, 2022

94noni commented Jul 20, 2022

fabpot commented Jul 21, 2022

[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output #46814

[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output #46814

Conversation

94noni commented Jun 30, 2022 • edited

This comment was marked as outdated.

ogizanagi commented Jul 3, 2022

94noni commented Jul 3, 2022

GromNaN left a comment

Choose a reason for hiding this comment

94noni commented Jul 4, 2022

94noni commented Jul 4, 2022

ogizanagi commented Jul 4, 2022 • edited

94noni commented Jul 4, 2022

ogizanagi commented Jul 4, 2022

94noni commented Jul 5, 2022

chalasr commented Jul 5, 2022

94noni commented Jul 5, 2022

chalasr commented Jul 5, 2022

94noni Jul 6, 2022

Choose a reason for hiding this comment

94noni Jul 6, 2022 • edited

Choose a reason for hiding this comment

94noni commented Jul 8, 2022

94noni commented Jul 18, 2022

fabpot commented Jul 20, 2022

94noni commented Jul 20, 2022

fabpot commented Jul 21, 2022

94noni commented Jun 30, 2022 •

edited

ogizanagi commented Jul 4, 2022 •

edited

94noni Jul 6, 2022 •

edited