[FrameworkBundle] add a notice when passing a routerInterface with warmupInterface in RouterCacheWarmer

Amrouche Hamza · Amrouche Hamza · commit 4128cf868830 · 2017-11-19T13:03:16.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
@@ -38,13 +38,19 @@ public function __construct(ContainerInterface $container)
      * Warms up the cache.
      *
      * @param string $cacheDir The cache directory
+     *
+     * @throws \LogicException
      */
     public function warmUp($cacheDir)
     {
         $router = $this->container->get('router');
 
         if ($router instanceof WarmableInterface) {
             $router->warmUp($cacheDir);
+
+            return;
+        } else {
+            @trigger_error(sprintf('Passing a %s without implementing %s is deprecated since 4.1.', RouterInterface::class, WarmableInterface::class), \E_USER_DEPRECATED);
         }
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/RouterCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/RouterCacheWarmerTest.php
@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\CacheWarmer;
+
+use Psr\Container\ContainerInterface;
+use Symfony\Bundle\FrameworkBundle\CacheWarmer\RouterCacheWarmer;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
+use Symfony\Component\Routing\RouterInterface;
+
+class RouterCacheWarmerTest extends TestCase
+{
+    public function testWarmUpWithWarmebleInterface()
+    {
+        $containerMock = $this->getMockBuilder(ContainerInterface::class)->setMethods(array('get', 'has'))->getMock();
+
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmebleInterface::class)->setMethods(array('match', 'generate', 'getContext', 'setContext', 'getRouteCollection', 'warmUp'))->getMock();
+        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+
+        $routerCacheWarmer->warmUp('/tmp');
+        $routerMock->expects($this->any())->method('warmUp')->with('/tmp')->willReturn('');
+        $this->addToAssertionCount(1);
+    }
+
+    /**
+     * @expectedDeprecation Passing a Symfony\Component\Routing\RouterInterface without implementing Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface is deprecated since 4.1.
+     * @group legacy
+     */
+    public function testWarmUpWithoutWarmebleInterface()
+    {
+        $containerMock = $this->getMockBuilder(ContainerInterface::class)->setMethods(array('get', 'has'))->getMock();
+
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmebleInterface::class)->setMethods(array('match', 'generate', 'getContext', 'setContext', 'getRouteCollection'))->getMock();
+        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+
+        $class = \LogicException::class;
+        if (method_exists($this, 'expectException')) {
+            $this->expectExceptionMessage(sprintf('%s should implement Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface in order to trigger a warmUp.', get_class($routerMock)));
+            $this->expectException($class);
+        } else {
+            $this->setExpectedException($class, sprintf('%s should implement Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface in order to trigger a warmUp.', get_class($routerMock)));
+        }
+
+        $routerCacheWarmer->warmUp('/tmp');
+    }
+}
+
+interface testRouterInterfaceWithWarmebleInterface extends RouterInterface, WarmableInterface
+{
+}
+
+interface testRouterInterfaceWithoutWarmebleInterface extends RouterInterface
+{
+}

Original file line number	Diff line number	Diff line change
`@@ -38,13 +38,19 @@ public function __construct(ContainerInterface $container)`
`38`	`38`	`* Warms up the cache.`
`39`	`39`	`*`
`40`	`40`	`* @param string $cacheDir The cache directory`
	`41`	`+ *`
	`42`	`+ * @throws \LogicException`
`41`	`43`	`*/`
`42`	`44`	`public function warmUp($cacheDir)`
`43`	`45`	`{`
`44`	`46`	`$router = $this->container->get('router');`
`45`	`47`
`46`	`48`	`if ($router instanceof WarmableInterface) {`
`47`	`49`	`$router->warmUp($cacheDir);`
	`50`	`+`
	`51`	`+ return;`
	`52`	`+ } else {`
	`53`	`+ @trigger_error(sprintf('Passing a %s without implementing %s is deprecated since 4.1.', RouterInterface::class, WarmableInterface::class), \E_USER_DEPRECATED);`
`48`	`54`	`}`
`49`	`55`	`}`
`50`	`56`