feature symfony#52962 [FrameworkBundle] Move Router cache directory to kernel.build_dir (Okhoshi)

This PR was squashed before being merged into the 7.1 branch.

Discussion
----------

[FrameworkBundle] Move Router cache directory to `kernel.build_dir`

| Q             | A
| ------------- | ---
| Branch?       | 7.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | none
| License       | MIT

Follow up to symfony#50391, set up Router cache directory to `kernel.build_dir` instead of `kernel.cache_dir` by default, and only warm the cache on read-only resources phase.

#SymfonyHackday

Commits
-------

1f031f8 [FrameworkBundle] Move Router cache directory to `kernel.build_dir`

Author: fabpot

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Move the Router `cache_dir` to `kernel.build_dir`
+ * Deprecate the `router.cache_dir` config option
+
 7.0
 ---
 

src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php

@@ -36,6 +36,10 @@ public function __construct(ContainerInterface $container)
 
     public function warmUp(string $cacheDir, string $buildDir = null): array
     {
+        if (!$buildDir) {
+            return [];
+        }
+
         $router = $this->container->get('router');
 
         if ($router instanceof WarmableInterface) {

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -613,7 +613,10 @@ private function addRouterSection(ArrayNodeDefinition $rootNode): void
                     ->children()
                         ->scalarNode('resource')->isRequired()->end()
                         ->scalarNode('type')->end()
-                        ->scalarNode('cache_dir')->defaultValue('%kernel.cache_dir%')->end()
+                        ->scalarNode('cache_dir')
+                            ->defaultValue('%kernel.build_dir%')
+                            ->setDeprecated('symfony/framework-bundle', '7.1', 'Setting the "%path%.%node%" configuration option is deprecated. It will be removed in version 8.0.')
+                        ->end()
                         ->scalarNode('default_uri')
                             ->info('The default URI used to generate URLs in a non-HTTP context')
                             ->defaultNull()

src/Symfony/Bundle/FrameworkBundle/Routing/Router.php

@@ -82,10 +82,14 @@ public function getRouteCollection(): RouteCollection
 
     public function warmUp(string $cacheDir, string $buildDir = null): array
     {
+        if (!$buildDir) {
+            return [];
+        }
+
         $currentDir = $this->getOption('cache_dir');
 
-        // force cache generation
-        $this->setOption('cache_dir', $cacheDir);
+        // force cache generation in build_dir
+        $this->setOption('cache_dir', $buildDir);
         $this->getMatcher();
         $this->getGenerator();
 

src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/RouterCacheWarmerTest.php

@@ -19,36 +19,61 @@
 
 class RouterCacheWarmerTest extends TestCase
 {
-    public function testWarmUpWithWarmebleInterface()
+    public function testWarmUpWithWarmableInterfaceWithBuildDir()
     {
         $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
 
-        $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmebleInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection', 'warmUp'])->getMock();
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmableInterface::class)->onlyMethods(['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([]);
+        $routerCacheWarmer->warmUp('/tmp/cache', '/tmp/build');
+        $routerMock->expects($this->any())->method('warmUp')->with('/tmp/cache', '/tmp/build')->willReturn([]);
         $this->addToAssertionCount(1);
     }
 
-    public function testWarmUpWithoutWarmebleInterface()
+    public function testWarmUpWithoutWarmableInterfaceWithBuildDir()
     {
         $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
 
-        $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmebleInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection'])->getMock();
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection'])->getMock();
         $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
         $routerCacheWarmer = new RouterCacheWarmer($containerMock);
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage('cannot be warmed up because it does not implement "Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface"');
-        $routerCacheWarmer->warmUp('/tmp');
+        $routerCacheWarmer->warmUp('/tmp/cache', '/tmp/build');
+    }
+
+    public function testWarmUpWithWarmableInterfaceWithoutBuildDir()
+    {
+        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection', 'warmUp'])->getMock();
+        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+
+        $preload = $routerCacheWarmer->warmUp('/tmp');
+        $routerMock->expects($this->never())->method('warmUp');
+        self::assertSame([], $preload);
+        $this->addToAssertionCount(1);
+    }
+
+    public function testWarmUpWithoutWarmableInterfaceWithoutBuildDir()
+    {
+        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+
+        $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection'])->getMock();
+        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+        $preload = $routerCacheWarmer->warmUp('/tmp');
+        self::assertSame([], $preload);
     }
 }
 
-interface testRouterInterfaceWithWarmebleInterface extends RouterInterface, WarmableInterface
+interface testRouterInterfaceWithWarmableInterface extends RouterInterface, WarmableInterface
 {
 }
 
-interface testRouterInterfaceWithoutWarmebleInterface extends RouterInterface
+interface testRouterInterfaceWithoutWarmableInterface extends RouterInterface
 {
 }

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -634,7 +634,7 @@ protected static function getBundleDefaultConfig()
                 'https_port' => 443,
                 'strict_requirements' => true,
                 'utf8' => true,
-                'cache_dir' => '%kernel.cache_dir%',
+                'cache_dir' => '%kernel.build_dir%',
             ],
             'session' => [
                 'enabled' => false,