[FrameworkBundle] Display the controller class name in 'debug:router' #20809

lyrixx · 2016-12-07T10:41:50Z

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

Before:

After:

yceruto · 2016-12-07T13:21:10Z

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

+            if ($route->hasDefault('_controller') && 'txt' === $input->getOption('format')) {
+                list($service, $method) = explode(':', $route->getDefault('_controller'), 2);
+                try {
+                    $route->setDefault('_controller', sprintf("%s:%s\n   (service: %s)", get_class($this->getContainer()->get($service)), $method, $service));


should be :: for fully-qualified class name and method (CNP)

yceruto · 2016-12-07T13:54:24Z

What do you think about to move the code to convertController() method to cover bin/console debug:router too (i.e. without name argument) ?

lyrixx · 2016-12-07T14:15:53Z

@yceruto I did it at the first attempt, but the output was really ugly :/

yceruto · 2016-12-07T14:53:16Z

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

@@ -87,6 +88,15 @@ protected function execute(InputInterface $input, OutputInterface $output)

            $this->convertController($route);

+            // Converts a short notation service:method to a class::method.
+            if ($route->hasDefault('_controller') && 'txt' === $input->getOption('format')) {
+                list($service, $method) = explode(':', $route->getDefault('_controller'), 2);


Be careful with this, it's not always service:method pattern, when a short notation controller (a:b:c) is provided (most of the time), things like this could happen:

# services.yml services: appbundle: class: stdClass

list($service, $method) = explode(':', 'AppBundle:Default:index', 2); // $service <<< 'AppBundle' // $method <<< 'Default:index' // so $this->getContainer()->get($service) //case insensitive // return a valid service "appbundle"

and then shows a wrong output:

$ bin/console debug:router index +--------------+---------------------------------------------------------+ | Property | Value | +--------------+---------------------------------------------------------+ | Defaults | _controller: stdClass:Default:index | | | (service: AppBundle) |

you may need to check if it's service:method pattern before.

lyrixx · 2016-12-08T19:20:29Z

@yceruto Thanks for the review. I have addressed your comments.

lyrixx · 2016-12-08T19:26:03Z

Actually, I would like to propose a new approach for this comment. Instead of displaying:

| Defaults     | _controller: AppBundle:Default:index                    |

Could we display:

| Defaults     | _controller: AppBundle:Default:index                              |
                      (class: AppBundle\Controller\DefaultController::indexAction) |

fabpot · 2016-12-09T07:28:38Z

What about removing the parentheses?

stof · 2016-12-09T11:22:39Z

This implementation has a drawback: it instantiate the controller (and of its dependencies).
could we use the dumped ContainerBuilder (used by debug:container) to look at the service definition instead (and skipping this enhanced behavior when we don't have this dumped ContainerBuilder) ?

lyrixx · 2016-12-13T17:42:54Z

@stof I think using the "dev" container is not a good idea, because some route could only exist in production, and it will became hard to debug. Thus, here we only instantiate one controller (and yes all deps). IMHO It's not a big deal.

lyrixx · 2016-12-13T18:01:11Z

I update the code to always display the class name (a:b:c or service:method notation).
And I updated the screenshot.

fabpot · 2016-12-13T20:05:05Z

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

+        $nameParser = $this->getContainer()->get('controller_name_converter');
+        try {
+            $shortNotation = $nameParser->build($controller);
+            $route->setDefault('_controller', sprintf("%s\n      class: %s", $shortNotation, $controller));


According to the screenshots, that's not a class, but a method.

lyrixx · 2016-12-22T15:44:13Z

I think this PR is ready

fabpot · 2016-12-22T17:06:50Z

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

+        if (1 === substr_count($controller, ':')) {
+            list($service, $method) = explode(':', $controller);
+            try {
+                $route->setDefault('_controller', sprintf("%s\n     method: %s::%s", $service, get_class($this->getContainer()->get($service)), $method));


I'm not sure I understand what you are doing here. IIUC, you are storing the text representation of the controller in the route _controller? Looks like it should be done when displaying the route instead.

Indeed, but I used the same hack as the previous implementation.

So is it a real problem ?

Fixed. I also update the screenshot.

xabbuh · 2016-12-30T10:41:22Z

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

@@ -92,6 +92,9 @@ protected function describeRoute(Route $route, array $options = array())
            array('Defaults', $this->formatRouterConfig($route->getDefaults())),
            array('Options', $this->formatRouterConfig($route->getOptions())),
        );
+        if ($options['callable']) {


Looking at the build failures, you need to check first that the callable key does exist.

Thanks. Fixed.

fabpot · 2017-01-02T20:07:43Z

Thank you @lyrixx.

… 'debug:router' (lyrixx) This PR was merged into the 3.3-dev branch. Discussion ---------- [FrameworkBundle] Display the controller class name in 'debug:router' | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - --- Before: ![screenshot7](https://cloud.githubusercontent.com/assets/408368/21152351/318af764-c166-11e6-8245-1729779e9809.png) After: ![screenshot3](https://cloud.githubusercontent.com/assets/408368/21563210/02cf043e-ce80-11e6-94be-34736d85bb3b.png) Commits ------- 157a830 [FrameworkBundle] Display the controller class name in 'debug:router'

carsonbot added Status: Needs Review DX DX = Developer eXperience (anything that improves the experience of using Symfony) FrameworkBundle Feature labels Dec 7, 2016

nicolas-grekas added this to the 3.x milestone Dec 7, 2016

yceruto reviewed Dec 7, 2016

View reviewed changes

lyrixx force-pushed the debug-router-with-service branch from 09f9626 to aadae0d Compare December 8, 2016 19:20

lyrixx force-pushed the debug-router-with-service branch from aadae0d to 543f496 Compare December 13, 2016 17:57

lyrixx changed the title ~~[DX][FrameworkBundle] Display the class name in 'debug:router' when the controller is a service~~ [DX][FrameworkBundle] Display the class name in 'debug:router' Dec 13, 2016

lyrixx force-pushed the debug-router-with-service branch from 543f496 to cd2a6c3 Compare December 13, 2016 18:01

fabpot reviewed Dec 13, 2016

View reviewed changes

lyrixx force-pushed the debug-router-with-service branch from cd2a6c3 to 2219eaf Compare December 13, 2016 20:17

fabpot reviewed Dec 22, 2016

View reviewed changes

lyrixx force-pushed the debug-router-with-service branch from 2219eaf to 9d91804 Compare December 27, 2016 10:45

lyrixx changed the title ~~[DX][FrameworkBundle] Display the class name in 'debug:router'~~ [FrameworkBundle] Display the controller class name in 'debug:router' Dec 27, 2016

lyrixx force-pushed the debug-router-with-service branch from 9d91804 to f88d154 Compare December 30, 2016 10:07

xabbuh requested changes Dec 30, 2016

View reviewed changes

[FrameworkBundle] Display the controller class name in 'debug:router'

157a830

lyrixx force-pushed the debug-router-with-service branch from f88d154 to 157a830 Compare December 30, 2016 10:47

fabpot merged commit 157a830 into symfony:master Jan 2, 2017

lyrixx deleted the debug-router-with-service branch January 2, 2017 21:52

javiereguiluz mentioned this pull request Jan 8, 2017

The debug:router command now displays the controller class name symfony/symfony-docs#7332

Closed

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] Display the controller class name in 'debug:router' #20809

[FrameworkBundle] Display the controller class name in 'debug:router' #20809

lyrixx commented Dec 7, 2016 •

edited

Loading

yceruto Dec 7, 2016

yceruto commented Dec 7, 2016 •

edited

Loading

lyrixx commented Dec 7, 2016

yceruto Dec 7, 2016 •

edited

Loading

lyrixx commented Dec 8, 2016

lyrixx commented Dec 8, 2016

fabpot commented Dec 9, 2016

stof commented Dec 9, 2016

lyrixx commented Dec 13, 2016

lyrixx commented Dec 13, 2016 •

edited

Loading

fabpot Dec 13, 2016

lyrixx Dec 13, 2016

lyrixx commented Dec 22, 2016

fabpot Dec 22, 2016

lyrixx Dec 22, 2016

lyrixx Dec 29, 2016

fabpot Dec 30, 2016

lyrixx Dec 30, 2016

xabbuh Dec 30, 2016

lyrixx Dec 30, 2016

fabpot commented Jan 2, 2017

[FrameworkBundle] Display the controller class name in 'debug:router' #20809

[FrameworkBundle] Display the controller class name in 'debug:router' #20809

Conversation

lyrixx commented Dec 7, 2016 • edited Loading

Choose a reason for hiding this comment

yceruto commented Dec 7, 2016 • edited Loading

lyrixx commented Dec 7, 2016

yceruto Dec 7, 2016 • edited Loading

Choose a reason for hiding this comment

lyrixx commented Dec 8, 2016

lyrixx commented Dec 8, 2016

fabpot commented Dec 9, 2016

stof commented Dec 9, 2016

lyrixx commented Dec 13, 2016

lyrixx commented Dec 13, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lyrixx commented Dec 22, 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

fabpot commented Jan 2, 2017

lyrixx commented Dec 7, 2016 •

edited

Loading

yceruto commented Dec 7, 2016 •

edited

Loading

yceruto Dec 7, 2016 •

edited

Loading

lyrixx commented Dec 13, 2016 •

edited

Loading