[FrameworkBundle] add --deprecations on debug:container command #32584

Simperfit · 2019-07-17T17:01:26Z

Q	A
Branch?	4.4
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#30089
License	MIT
Doc PR	todo

Two question for this:

~~is a table output enough ?~~
do we need to create a trait to share the code to the cache:warmup ? or maybe add a notice if there deprecation to check them with this command ?

Edit: new output

yceruto

When the deprecation message is too large, the output is unreadable. Could we format that message? or do we have an option in the table helper to set the width of the column?

BTW very useful command, thanks!

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

nicolas-grekas · 2019-07-17T18:13:32Z

I would remove the table and take inspiration from the reports from the bridge if that makes sense.
Also, the name might be confusing: this is only about deprecations triggered during compile+warmup. There can be many more.

Simperfit · 2019-07-17T18:17:27Z

I will check that ! Thanks. Maybe we could call it DebugContainerCompiledDeprecation (that’s big ;)) Le mer. 17 juil. 2019 à 20:13, Nicolas Grekas <notifications@github.com> a écrit :

…

I would remove the table and take inspiration from the reports from the bridge if that makes sense. Also, the name might be confision: this is only about deprecations triggered during compile+warmup. There can be many more. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#32584?email_source=notifications&email_token=AA2KV4WMVDFWA6X4D66R5ZTP75OOLA5CNFSM4IESRN3KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2GEDOY#issuecomment-512508347>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA2KV4RMDLA4FXBFFRWAA3TP75OOLANCNFSM4IESRN3A> .

Simperfit · 2019-07-17T21:24:06Z

@nicolas-grekas updated according to the bridge

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

Simperfit · 2019-07-22T09:00:28Z

cc @yceruto WDYT ?

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

nicolas-grekas · 2019-07-23T08:53:24Z

~~Wait, are deprecations triggered during warmup really added to Deprecations.log?~~

Simperfit · 2019-07-23T08:58:48Z

@nicolas-grekas I've taken this finally close into account in order to get the serialized data and the path of the file I wanted to use:

symfony/src/Symfony/Component/HttpKernel/CacheWarmer/CacheWarmerAggregate.php

Lines 99 to 107 in 2ab1521

    
           if ($this->debug && true !== $previousHandler) { 
        
               restore_error_handler(); 
        
               if (file_exists($this->deprecationLogsFilepath)) { 
        
                   $previousLogs = unserialize(file_get_contents($this->deprecationLogsFilepath)); 
        
                   $collectedLogs = array_merge($previousLogs, $collectedLogs); 
        
               } 
        
               file_put_contents($this->deprecationLogsFilepath, serialize(array_values($collectedLogs)));

I think this is really the deprecation collected during cache warmup.

nicolas-grekas · 2019-07-23T09:05:00Z

Oh, sorry I forgot about that :)
So, does this contains deprecations for container compilation too?

Simperfit · 2019-07-23T09:23:50Z

Since we collect the same logs during container compilations, I think it does too

nicolas-grekas · 2019-07-23T09:27:43Z

So do, debug:container --deprecations ?

Simperfit · 2019-08-09T11:40:14Z

PR rebased and comments fixed.

Simperfit · 2019-08-13T13:51:00Z

cc @yceruto

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

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

Simperfit · 2019-08-14T05:41:22Z

PR updated and ready !

fabpot · 2019-08-18T08:27:07Z

Why don't we supported all formats (JSON, Markdown and XML)?

Simperfit · 2019-08-19T06:30:01Z

I don't see the need of getting this information in JSON for example ATM.

fabpot · 2019-08-19T06:42:53Z

The support for many formats is for integration with third-party tools.

fabpot · 2019-09-27T06:02:18Z

@Simperfit Do you have to finish this PR? We won't merge it if we don't support all formats. Or maybe someone else can take over to finish it, it should not be too time consuming.

nicolas-grekas · 2019-09-27T16:53:36Z

FYI, I rebased your branch
Small remaining details: when I run the command,the output shows
To search for a specific service, [...] at the end, that should be removed.

nicolas-grekas · 2019-09-27T16:56:12Z

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

+        $formattedLogs = [];
+        $remainingCount = 0;
+        foreach ($logs as $log) {
+            $formattedLogs[] = sprintf("%sx: %s \n      in %s:%s", $log['count'], $log['message'], $log['file'], $log['line']);


we should use <href=%s>%s:%d</> here, to generate IDE links (which means using the FileLinkFormatter service to compute it)

chalasr · 2019-08-20T22:29:37Z

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

@@ -143,6 +146,11 @@ protected function write($content, $decorated = false)
     */
    abstract protected function describeContainerServices(ContainerBuilder $builder, array $options = []);

+    /**
+     * Describes container deprecations.
+     */


can be removed

chalasr · 2019-08-20T22:58:30Z

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

@@ -149,6 +154,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
        } elseif ($name = $input->getArgument('name')) {
            $name = $this->findProperServiceName($input, $errorIo, $object, $name, $input->getOption('show-hidden'));
            $options = ['id' => $name];
+        } elseif ($input->getOption('deprecations')) {
+            $options = ['deprecations' => true];


validateInput() needs to be updated to forbid combining this option with others.

fabpot · 2020-02-04T13:30:57Z

Any news here? Anyone willing to take over?

nicolas-grekas · 2020-02-04T13:33:41Z

Closing as stale, anyone willing to help, please start from this PR.

noemi-salaun · 2020-03-07T09:22:36Z

I'll try implementing missing formats (md, json and xml)

@Simperfit

…r command (Simperfit, noemi-salaun) This PR was merged into the 5.1-dev branch. Discussion ---------- [FrameworkBundle] add --deprecations on debug:container command | Q | A | ------------- | --- | Branch? | master (5.1) | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | #30089  | License | MIT | Doc PR | todo _I apologize in advance, I am not fluent in English_ Continuity of @Simperfit work from his PR #32584 I added support for XML, JSON and markdown formats as well as unit tests for all formats. ## XML format ```xml <?xml version="1.0" encoding="UTF-8"?> <deprecations remainingCount="5"> <deprecation count="3"> <message>Some deprecation message.</message> <file>/path/to/some/file.php</file> <line>39</line> </deprecation> <deprecation count="2"> <message>An other deprecation message.</message> <file>/path/to/an/other/file.php</file> <line>25</line> </deprecation> </deprecations> ``` ## JSON format ```json { "remainingCount": 5, "deprecations": [ { "message": "Some deprecation message.", "file": "\/path\/to\/some\/file.php", "line": 39, "count": 3 }, { "message": "An other deprecation message.", "file": "\/path\/to\/an\/other\/file.php", "line": 25, "count": 2 } ] } ``` ## Markdown format ## Remaining deprecations (5) - 3x: "Some deprecation message." in /path/to/some/file.php:39 - 2x: "An other deprecation message." in /path/to/an/other/file.php:25 I added a new commit on top of @Simperfit 's one, but I don't know how you would like to have the git history writed. Commits ------- ee6391e [FrameworkBundle] add all formats support for debug:container --deprecations command 161f659 [FrameworkBundle] add --deprecations on debug:container command

Simperfit force-pushed the feature/add-debug-deprecations-command branch 2 times, most recently from e504ade to 2728a8d Compare July 17, 2019 17:07

yceruto added Feature FrameworkBundle labels Jul 17, 2019

yceruto added this to the next milestone Jul 17, 2019

Simperfit force-pushed the feature/add-debug-deprecations-command branch 3 times, most recently from 5f14174 to ad4acac Compare July 17, 2019 17:49

yceruto requested changes Jul 17, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/DebugDeprecationsCommand.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Command/DebugDeprecationsCommand.php Outdated Show resolved Hide resolved

Simperfit force-pushed the feature/add-debug-deprecations-command branch 3 times, most recently from ed04eb3 to b21cc72 Compare July 17, 2019 21:23

Simperfit changed the title ~~[FrameworkBundle] add debug:deprecations command~~ [FrameworkBundle] add debug:warmed-deprecations command Jul 17, 2019

ro0NL reviewed Jul 18, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/DebugWarmedDeprecationsCommand.php Outdated Show resolved Hide resolved

Simperfit changed the title ~~[FrameworkBundle] add debug:warmed-deprecations command~~ [FrameworkBundle] add debug:deprecations:warmed command Jul 18, 2019

Simperfit force-pushed the feature/add-debug-deprecations-command branch 3 times, most recently from 4f156ea to 43f18cd Compare July 18, 2019 11:48

yceruto reviewed Jul 22, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/DebugDeprecationsWarmedCommand.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Command/DebugDeprecationsWarmedCommand.php Outdated Show resolved Hide resolved

Simperfit force-pushed the feature/add-debug-deprecations-command branch from 43f18cd to c27ad7a Compare July 23, 2019 06:50

Simperfit force-pushed the feature/add-debug-deprecations-command branch from c27ad7a to 77d5061 Compare July 23, 2019 12:12

carsonbot added Status: Reviewed and removed Status: Needs Review labels Aug 8, 2019

Simperfit force-pushed the feature/add-debug-deprecations-command branch from 8ba1bda to 6f00187 Compare August 9, 2019 11:39

maxhelias approved these changes Aug 9, 2019

View reviewed changes

yceruto approved these changes Aug 13, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md Outdated Show resolved Hide resolved

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

maxhelias mentioned this pull request Aug 13, 2019

[FrameworkBundle] Add debug:autoconfigure command #31183

Closed

Simperfit force-pushed the feature/add-debug-deprecations-command branch from 6f00187 to 4b62442 Compare August 14, 2019 05:41

[FrameworkBundle] add --deprecations on debug:container command

9a97e33

nicolas-grekas force-pushed the feature/add-debug-deprecations-command branch from 4b62442 to 9a97e33 Compare September 27, 2019 16:46

nicolas-grekas reviewed Sep 27, 2019

View reviewed changes

chalasr requested changes Sep 27, 2019

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Sep 27, 2019

nicolas-grekas added the Help wanted Issues and PRs which are looking for volunteers to complete them. label Feb 4, 2020

nicolas-grekas closed this Feb 4, 2020

noemi-salaun mentioned this pull request Mar 7, 2020

[FrameworkBundle] add --deprecations on debug:container command #35995

Merged

nicolas-grekas modified the milestones: next, 5.1 May 4, 2020

Uh oh!

[FrameworkBundle] add --deprecations on debug:container command #32584

[FrameworkBundle] add --deprecations on debug:container command #32584

Uh oh!

Conversation

Simperfit commented Jul 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yceruto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Jul 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Simperfit commented Jul 17, 2019 via email

Uh oh!

Simperfit commented Jul 17, 2019

Uh oh!

Uh oh!

Simperfit commented Jul 22, 2019

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Jul 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Simperfit commented Jul 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Jul 23, 2019

Uh oh!

Simperfit commented Jul 23, 2019

Uh oh!

nicolas-grekas commented Jul 23, 2019

Uh oh!

Simperfit commented Aug 9, 2019

Uh oh!

Simperfit commented Aug 13, 2019

Uh oh!

Uh oh!

Uh oh!

Simperfit commented Aug 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabpot commented Aug 18, 2019

Uh oh!

Simperfit commented Aug 19, 2019

Uh oh!

fabpot commented Aug 19, 2019

Uh oh!

fabpot commented Sep 27, 2019

Uh oh!

nicolas-grekas commented Sep 27, 2019

Uh oh!

nicolas-grekas Sep 27, 2019

Choose a reason for hiding this comment

Uh oh!

chalasr Aug 20, 2019

Choose a reason for hiding this comment

Uh oh!

chalasr Aug 20, 2019

Choose a reason for hiding this comment

Uh oh!

fabpot commented Feb 4, 2020

Uh oh!

nicolas-grekas commented Feb 4, 2020

Uh oh!

noemi-salaun commented Mar 7, 2020

Uh oh!

Uh oh!

Simperfit commented Jul 17, 2019 •

edited

Loading

nicolas-grekas commented Jul 17, 2019 •

edited

Loading

nicolas-grekas commented Jul 23, 2019 •

edited

Loading

Simperfit commented Jul 23, 2019 •

edited

Loading

Simperfit commented Aug 14, 2019 •

edited

Loading