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

Amrouche Hamza · Amrouche Hamza · commit 18453aa9e351 · 2017-12-06T15:00:51.000+01:00
diff --git a/UPGRADE-4.1.md b/UPGRADE-4.1.md
@@ -16,3 +16,8 @@ Translation
 
  * The `FileDumper::setBackup()` method is deprecated and will be removed in 5.0.
  * The `TranslationWriter::disableBackup()` method is deprecated and will be removed in 5.0.
+
+FrameworkBundle
+---------------
+
+ * A `RouterInterface` that does not implement the `WarmableInterface` is deprecated and will not be supported in Symfony 5.0.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -16,3 +16,8 @@ Translation
 
  * The `FileDumper::setBackup()` method has been removed.
  * The `TranslationWriter::disableBackup()` method has been removed.
+
+FrameworkBundle
+---------------
+
+ * Using a `RouterInterface` that does not implement the `WarmableInterface` is not supported anymore.
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -5,7 +5,8 @@ CHANGELOG
 -----
 
  * allowed to pass an optional `LoggerInterface $logger` instance to the `Router`
-
+ * Using a `RouterInterface` that does not implement the `WarmableInterface` is deprecated and will not be supported in Symfony 5.0.
+ 
 4.0.0
 -----
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
@@ -45,7 +45,11 @@ public function warmUp($cacheDir)
 
         if ($router instanceof WarmableInterface) {
             $router->warmUp($cacheDir);
+
+            return;
         }
+
+        @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,56 @@
+<?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);
+        $routerCacheWarmer->warmUp('/tmp');
+    }
+}
+
+interface testRouterInterfaceWithWarmebleInterface extends RouterInterface, WarmableInterface
+{
+}
+
+interface testRouterInterfaceWithoutWarmebleInterface extends RouterInterface
+{
+}

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,11 @@ public function warmUp($cacheDir)`
`45`	`45`
`46`	`46`	`if ($router instanceof WarmableInterface) {`
`47`	`47`	`$router->warmUp($cacheDir);`
	`48`	`+`
	`49`	`+ return;`
`48`	`50`	`}`
	`51`	`+`
	`52`	`+ @trigger_error(sprintf('Passing a %s without implementing %s is deprecated since 4.1.', RouterInterface::class, WarmableInterface::class), \E_USER_DEPRECATED);`
`49`	`53`	`}`
`50`	`54`
`51`	`55`	`/**`