feature #6570 Use buildDir for cache (alexndlm)

This PR was squashed before being merged into the 4.x branch.

Discussion
----------

Use buildDir for cache

Feature available since Symfony 5.2 - symfony/symfony#36515

Commits
-------

9daaade Use buildDir for cache

Author: javiereguiluz

config/services.php

@@ -180,7 +180,7 @@
             ->tag('kernel.event_listener', ['event' => ViewEvent::class])
 
         ->set(AdminContextFactory::class)
-            ->arg(0, '%kernel.cache_dir%')
+            ->arg(0, '%kernel.build_dir%')
             ->arg(1, new Reference('security.token_storage', ContainerInterface::NULL_ON_INVALID_REFERENCE))
             ->arg(2, new Reference(MenuFactory::class))
             ->arg(3, new Reference(CrudControllerRegistry::class))

src/Cache/CacheWarmer.php

@@ -30,47 +30,51 @@ public function isOptional(): bool
 
     public function warmUp(string $cacheDir, ?string $buildDir = null): array
     {
-        $allRoutes = $this->router->getRouteCollection();
-        $dashboardRoutes = [];
-
-        /** @var Route $route */
-        foreach ($allRoutes as $routeName => $route) {
-            $controller = $route->getDefault('_controller') ?? '';
-            // controller is defined as $router->add('admin', '/')->controller(DashboardController::class)
-            if (\is_string($controller) && '' !== $controller && class_exists($controller)) {
-                $controller .= '::__invoke';
-            }
+        $cacheFilename = ($buildDir ?? $cacheDir).'/'.self::DASHBOARD_ROUTES_CACHE;
 
-            // controller is defined as $router->add('admin', '/')->controller([DashboardController::class, 'index'])
-            if (\is_array($controller)) {
-                $controller = $controller[0].'::'.($controller[1] ?? '__invoke');
-            }
+        if (false === file_exists($cacheFilename)) {
+            $allRoutes = $this->router->getRouteCollection();
+            $dashboardRoutes = [];
 
-            $controller = u($controller);
-            if ($controller->isEmpty()) {
-                // this happens e.g. when using 'lexik/jwt-authentication-bundle', which defines an empty controller
-                continue;
-            }
+            /** @var Route $route */
+            foreach ($allRoutes as $routeName => $route) {
+                $controller = $route->getDefault('_controller') ?? '';
+                // controller is defined as $router->add('admin', '/')->controller(DashboardController::class)
+                if (\is_string($controller) && '' !== $controller && class_exists($controller)) {
+                    $controller .= '::__invoke';
+                }
 
-            if (!$controller->endsWith('::index') && !$controller->endsWith('::__invoke')) {
-                continue;
-            }
+                // controller is defined as $router->add('admin', '/')->controller([DashboardController::class, 'index'])
+                if (\is_array($controller)) {
+                    $controller = $controller[0].'::'.($controller[1] ?? '__invoke');
+                }
 
-            $controllerFqcn = $controller->beforeLast('::')->toString();
-            if (!is_subclass_of($controllerFqcn, DashboardControllerInterface::class)) {
-                continue;
+                $controller = u($controller);
+                if ($controller->isEmpty()) {
+                    // this happens e.g. when using 'lexik/jwt-authentication-bundle', which defines an empty controller
+                    continue;
+                }
+
+                if (!$controller->endsWith('::index') && !$controller->endsWith('::__invoke')) {
+                    continue;
+                }
+
+                $controllerFqcn = $controller->beforeLast('::')->toString();
+                if (!is_subclass_of($controllerFqcn, DashboardControllerInterface::class)) {
+                    continue;
+                }
+
+                // when using i18n routes, the same controller can be associated to
+                // multiple routes (e.g. 'admin.en', 'admin.es', 'admin.fr', etc.)
+                $dashboardRoutes[$routeName] = $controller->toString();
             }
 
-            // when using i18n routes, the same controller can be associated to
-            // multiple routes (e.g. 'admin.en', 'admin.es', 'admin.fr', etc.)
-            $dashboardRoutes[$routeName] = $controller->toString();
+            (new Filesystem())->dumpFile(
+                $cacheFilename,
+                '<?php return '.var_export($dashboardRoutes, true).';'
+            );
         }
 
-        (new Filesystem())->dumpFile(
-            $cacheDir.'/'.self::DASHBOARD_ROUTES_CACHE,
-            '<?php return '.var_export($dashboardRoutes, true).';'
-        );
-
         // we don't use this, but it's required by the interface to return the list of classes to preload
         return [];
     }

src/DependencyInjection/CreateControllerRegistriesPass.php

@@ -35,7 +35,7 @@ private function createDashboardControllerRegistryService(ContainerBuilder $cont
             ->register(DashboardControllerRegistry::class, DashboardControllerRegistry::class)
             ->setPublic(false)
             ->setArguments([
-                $container->getParameter('kernel.cache_dir'),
+                $container->getParameter('kernel.build_dir'),
                 $controllerFqcnToContextIdMap,
                 array_flip($controllerFqcnToContextIdMap),
             ]);

src/Factory/AdminContextFactory.php

@@ -33,16 +33,16 @@
  */
 final class AdminContextFactory
 {
-    private string $cacheDir;
+    private string $buildDir;
     private ?TokenStorageInterface $tokenStorage;
     private MenuFactoryInterface $menuFactory;
     private CrudControllerRegistry $crudControllers;
     private EntityFactory $entityFactory;
     private AdminRouteGenerator $adminRouteGenerator;
 
-    public function __construct(string $cacheDir, ?TokenStorageInterface $tokenStorage, MenuFactoryInterface $menuFactory, CrudControllerRegistry $crudControllers, EntityFactory $entityFactory, AdminRouteGenerator $adminRouteGenerator)
+    public function __construct(string $buildDir, ?TokenStorageInterface $tokenStorage, MenuFactoryInterface $menuFactory, CrudControllerRegistry $crudControllers, EntityFactory $entityFactory, AdminRouteGenerator $adminRouteGenerator)
     {
-        $this->cacheDir = $cacheDir;
+        $this->buildDir = $buildDir;
         $this->tokenStorage = $tokenStorage;
         $this->menuFactory = $menuFactory;
         $this->crudControllers = $crudControllers;
@@ -75,7 +75,7 @@ public function create(Request $request, DashboardControllerInterface $dashboard
 
     private function getDashboardDto(Request $request, DashboardControllerInterface $dashboardControllerInstance): DashboardDto
     {
-        $dashboardRoutesCachePath = $this->cacheDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
+        $dashboardRoutesCachePath = $this->buildDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
         $dashboardControllerRoutes = !file_exists($dashboardRoutesCachePath) ? [] : require $dashboardRoutesCachePath;
         $dashboardController = $dashboardControllerInstance::class.'::index';
         $dashboardRouteName = null;

src/Registry/DashboardControllerRegistry.php

@@ -15,11 +15,11 @@ final class DashboardControllerRegistry implements DashboardControllerRegistryIn
      * @param string[] $contextIdToControllerFqcnMap
      */
     public function __construct(
-        string $cacheDir,
+        string $buildDir,
         private readonly array $controllerFqcnToContextIdMap,
         private readonly array $contextIdToControllerFqcnMap,
     ) {
-        $dashboardRoutesCachePath = $cacheDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
+        $dashboardRoutesCachePath = $buildDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
         $dashboardControllerRoutes = !file_exists($dashboardRoutesCachePath) ? [] : require $dashboardRoutesCachePath;
         foreach ($dashboardControllerRoutes as $routeName => $controller) {
             $this->controllerFqcnToRouteMap[u($controller)->before('::')->toString()] = $routeName;