deprecate not passing a build dir when warming up the router cache

xabbuh · xabbuh · commit 78470abd7970 · 2024-01-07T17:47:32.000+01:00
diff --git a/UPGRADE-7.1.md b/UPGRADE-7.1.md
@@ -9,6 +9,7 @@ Cache
 FrameworkBundle
 ---------------
 
+ * Deprecate not passing a build dir to `RouterCacheWarmer::warmUp()` and `Router::warmUp()`
  * Mark classes `ConfigBuilderCacheWarmer`, `Router`, `SerializerCacheWarmer`, `TranslationsCacheWarmer`, `Translator` and `ValidatorCacheWarmer` as `final`
 
 Messenger
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 7.1
 ---
 
+ * Deprecate not passing a build dir to `RouterCacheWarmer::warmUp()` and `Router::warmUp()`
  * Add `private_ranges` as a shortcut for private IP address ranges to the `trusted_proxies` option
  * Mark classes `ConfigBuilderCacheWarmer`, `Router`, `SerializerCacheWarmer`, `TranslationsCacheWarmer`, `Translator` and `ValidatorCacheWarmer` as `final`
  * Move the Router `cache_dir` to `kernel.build_dir`
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
@@ -36,14 +36,15 @@ public function __construct(ContainerInterface $container)
 
     public function warmUp(string $cacheDir, string $buildDir = null): array
     {
-        if (!$buildDir) {
-            return [];
+        if (null === $buildDir) {
+            trigger_deprecation('symfony/framework-bundle', '7.1', sprintf('Not passing a build dir as the second argument to "%s()" is deprecated.', __METHOD__));
+            // return [];
         }
 
         $router = $this->container->get('router');
 
         if ($router instanceof WarmableInterface) {
-            return (array) $router->warmUp($cacheDir, $buildDir);
+            return (array) $router->warmUp($cacheDir, $buildDir, false);
         }
 
         throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
@@ -84,14 +84,17 @@ public function getRouteCollection(): RouteCollection
 
     public function warmUp(string $cacheDir, string $buildDir = null): array
     {
-        if (!$buildDir) {
-            return [];
+        if (null === $buildDir) {
+            if (\func_num_args() < 3) {
+                trigger_deprecation('symfony/framework-bundle', '7.1', sprintf('Not passing a build dir as the second argument to "%s()" is deprecated.', __METHOD__));
+            }
+            // return [];
         }
 
         $currentDir = $this->getOption('cache_dir');
 
-        // force cache generation in build_dir
-        $this->setOption('cache_dir', $buildDir);
+        // force cache generation (in build_dir if present)
+        $this->setOption('cache_dir', $buildDir ?? $cacheDir);
         $this->getMatcher();
         $this->getGenerator();
 

Original file line number	Diff line number	Diff line change
`@@ -36,14 +36,15 @@ public function __construct(ContainerInterface $container)`
`36`	`36`
`37`	`37`	`public function warmUp(string $cacheDir, string $buildDir = null): array`
`38`	`38`	`{`
`39`		`- if (!$buildDir) {`
`40`		`- return [];`
	`39`	`+ if (null === $buildDir) {`
	`40`	`+ trigger_deprecation('symfony/framework-bundle', '7.1', sprintf('Not passing a build dir as the second argument to "%s()" is deprecated.', __METHOD__));`
	`41`	`+ // return [];`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`$router = $this->container->get('router');`
`44`	`45`
`45`	`46`	`if ($router instanceof WarmableInterface) {`
`46`		`- return (array) $router->warmUp($cacheDir, $buildDir);`
	`47`	`+ return (array) $router->warmUp($cacheDir, $buildDir, false);`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));`