Throw a sensible exception when controller has been removed

sroze · sroze · commit df6b2382d397 · 2017-12-05T16:54:44.000Z
diff --git a/src/Symfony/Component/HttpKernel/Controller/ContainerControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/ContainerControllerResolver.php
@@ -75,6 +75,8 @@ protected function createController($controller)
             return $service;
         }
 
+        $this->throwExceptionIfControllerWasRemoved($controller);
+
         throw new \LogicException(sprintf('Unable to parse the controller name "%s".', $controller));
     }
 
@@ -94,10 +96,19 @@ protected function instantiateController($class)
         } catch (\TypeError $e) {
         }
 
-        if ($this->container instanceof Container && isset($this->container->getRemovedIds()[$class])) {
-            throw new \LogicException(sprintf('Controller "%s" cannot be fetched from the container because it is private. Did you forget to tag the service with "controller.service_arguments"?', $class), 0, $e);
-        }
+        $this->throwExceptionIfControllerWasRemoved($class, $e);
 
         throw $e;
     }
+
+    /**
+     * @param string                     $controller
+     * @param \Exception|\Throwable|null $previous
+     */
+    private function throwExceptionIfControllerWasRemoved($controller, $previous = null)
+    {
+        if ($this->container instanceof Container && isset($this->container->getRemovedIds()[$controller])) {
+            throw new \LogicException(sprintf('Controller "%s" cannot be fetched from the container because it is private. Did you forget to tag the service with "controller.service_arguments"?', $controller), 0, $previous);
+        }
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ContainerControllerResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ContainerControllerResolverTest.php
@@ -175,6 +175,32 @@ public function testNonInstantiableControllerWithCorrespondingService()
         $this->assertSame(array($service, 'action'), $controller);
     }
 
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessage Controller "app.my_controller" cannot be fetched from the container because it is private. Did you forget to tag the service with "controller.service_arguments"?
+     */
+    public function testExceptionWhenUsingRemovedControllerService()
+    {
+        $container = $this->getMockBuilder(Container::class)->getMock();
+        $container->expects($this->at(0))
+            ->method('has')
+            ->with('app.my_controller')
+            ->will($this->returnValue(true))
+        ;
+
+        $container->expects($this->atLeastOnce())
+            ->method('getRemovedIds')
+            ->with()
+            ->will($this->returnValue(array('app.my_controller' => true)))
+        ;
+
+        $resolver = $this->createControllerResolver(null, $container);
+
+        $request = Request::create('/');
+        $request->attributes->set('_controller', 'app.my_controller');
+        $resolver->getController($request);
+    }
+
     /**
      * @dataProvider getUndefinedControllers
      */

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,8 @@ protected function createController($controller)`
`75`	`75`	`return $service;`
`76`	`76`	`}`
`77`	`77`
	`78`	`+ $this->throwExceptionIfControllerWasRemoved($controller);`
	`79`	`+`
`78`	`80`	`throw new \LogicException(sprintf('Unable to parse the controller name "%s".', $controller));`
`79`	`81`	`}`
`80`	`82`
`@@ -94,10 +96,19 @@ protected function instantiateController($class)`
`94`	`96`	`} catch (\TypeError $e) {`
`95`	`97`	`}`
`96`	`98`
`97`		`- if ($this->container instanceof Container && isset($this->container->getRemovedIds()[$class])) {`
`98`		`- throw new \LogicException(sprintf('Controller "%s" cannot be fetched from the container because it is private. Did you forget to tag the service with "controller.service_arguments"?', $class), 0, $e);`
`99`		`- }`
	`99`	`+ $this->throwExceptionIfControllerWasRemoved($class, $e);`
`100`	`100`
`101`	`101`	`throw $e;`
`102`	`102`	`}`
	`103`	`+`
	`104`	`+ /**`
	`105`	`+ * @param string $controller`
	`106`	`+ * @param \Exception\|\Throwable\|null $previous`
	`107`	`+ */`
	`108`	`+ private function throwExceptionIfControllerWasRemoved($controller, $previous = null)`
	`109`	`+ {`
	`110`	`+ if ($this->container instanceof Container && isset($this->container->getRemovedIds()[$controller])) {`
	`111`	`+ throw new \LogicException(sprintf('Controller "%s" cannot be fetched from the container because it is private. Did you forget to tag the service with "controller.service_arguments"?', $controller), 0, $previous);`
	`112`	`+ }`
	`113`	`+ }`
`103`	`114`	`}`