Update warmup signature on all WarmableInterface implementations

okhoshi · okhoshi · commit 931cc08f7afa · 2023-10-10T14:55:06.000+02:00
Signed-off-by: Quentin Devos &lt;4972091+Okhoshi@users.noreply.github.com&gt;
diff --git a/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php b/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php
@@ -40,9 +40,11 @@ public function isOptional(): bool
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[] A list of files to preload on PHP 7.4+
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $files = [];
         foreach ($this->registry->getManagers() as $em) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php
@@ -35,9 +35,11 @@ public function isOptional(): bool
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[] A list of classes to preload on PHP 7.4+
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $arrayAdapter = new ArrayAdapter();
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/CachePoolClearerCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/CachePoolClearerCacheWarmer.php
@@ -40,7 +40,7 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])
     /**
      * @return string[]
      */
-    public function warmUp(string $cacheDirectory): array
+    public function warmUp(string $cacheDirectory, string $buildDir = null): array
     {
         foreach ($this->pools as $pool) {
             if ($this->poolClearer->hasPool($pool)) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
@@ -34,7 +34,11 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    public function warmUp(string $cacheDir): array
+    /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
+     */
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $router = $this->container->get('router');
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php
@@ -34,9 +34,11 @@ public function __construct(ContainerInterface $container)
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[]
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $this->translator ??= $this->container->get('translator');
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
@@ -81,9 +81,11 @@ public function getRouteCollection(): RouteCollection
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[] A list of classes to preload on PHP 7.4+
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $currentDir = $this->getOption('cache_dir');
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/CacheClearCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/CacheClearCommandTest.php
@@ -111,6 +111,7 @@ public function testCacheIsWarmedWhenCalledTwice()
         $application->doRun($input, new NullOutput());
 
         $this->assertTrue(is_file($this->kernel->getCacheDir().'/dummy.txt'));
+        $this->assertTrue(is_file($this->kernel->getBuildDir().'/build-dummy.txt'));
     }
 
     public function testCacheIsWarmedWithOldContainer()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/Fixture/TestAppKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/Fixture/TestAppKernel.php
@@ -52,9 +52,12 @@ public function isOptional(): bool
         return false;
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         file_put_contents($cacheDir.'/dummy.txt', 'Hello');
+        if (null !== $buildDir) {
+            file_put_contents($buildDir . '/build-dummy.txt', 'Hello');
+        }
 
         return [];
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -95,9 +95,11 @@ public function __construct(ContainerInterface $container, MessageFormatterInter
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[]
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         // skip warmUp when translator doesn't use cache
         if (null === $this->options['cache_dir']) {
diff --git a/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php b/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php
@@ -35,9 +35,11 @@ public function isOptional(): bool
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[]
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         foreach ($this->expressions as $expression) {
             $this->expressionLanguage->parse($expression, ['token', 'user', 'object', 'subject', 'role_names', 'request', 'trust_resolver']);
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php
@@ -36,9 +36,11 @@ public function __construct(ContainerInterface $container, iterable $iterator)
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[] A list of template files to preload on PHP 7.4+
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $this->twig ??= $this->container->get('twig');
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/CacheWarmer/CacheWarmerTest.php b/src/Symfony/Component/HttpKernel/Tests/CacheWarmer/CacheWarmerTest.php
@@ -54,7 +54,7 @@ public function __construct(string $file)
         $this->file = $file;
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         $this->writeCacheFile($this->file, 'content');
 
diff --git a/src/Symfony/Component/Serializer/CacheWarmer/CompiledClassMetadataCacheWarmer.php b/src/Symfony/Component/Serializer/CacheWarmer/CompiledClassMetadataCacheWarmer.php
@@ -29,7 +29,7 @@ public function __construct(
     ) {
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         $metadatas = [];
 
diff --git a/src/Symfony/Component/Translation/DataCollectorTranslator.php b/src/Symfony/Component/Translation/DataCollectorTranslator.php
@@ -72,9 +72,11 @@ public function getCatalogues(): array
     }
 
     /**
+     * @param string|null $buildDir directory to put generated source code that can be marked as read-only at runtime.
+     *                              The directory is not provided when only cache_dir should be warmed up.
      * @return string[]
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         if ($this->translator instanceof WarmableInterface) {
             return (array) $this->translator->warmUp($cacheDir);

Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,11 @@ public function isOptional(): bool`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
	`43`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`44`	`+ * The directory is not provided when only cache_dir should be warmed up.`
`43`	`45`	`* @return string[] A list of files to preload on PHP 7.4+`
`44`	`46`	`*/`
`45`		`- public function warmUp(string $cacheDir): array`
	`47`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`46`	`48`	`{`
`47`	`49`	`$files = [];`
`48`	`50`	`foreach ($this->registry->getManagers() as $em) {`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,11 @@ public function isOptional(): bool`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
	`38`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`39`	`+ * The directory is not provided when only cache_dir should be warmed up.`
`38`	`40`	`* @return string[] A list of classes to preload on PHP 7.4+`
`39`	`41`	`*/`
`40`		`- public function warmUp(string $cacheDir): array`
	`42`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`41`	`43`	`{`
`42`	`44`	`$arrayAdapter = new ArrayAdapter();`
`43`	`45`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])`
`40`	`40`	`/**`
`41`	`41`	`* @return string[]`
`42`	`42`	`*/`
`43`		`- public function warmUp(string $cacheDirectory): array`
	`43`	`+ public function warmUp(string $cacheDirectory, string $buildDir = null): array`
`44`	`44`	`{`
`45`	`45`	`foreach ($this->pools as $pool) {`
`46`	`46`	`if ($this->poolClearer->hasPool($pool)) {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,11 @@ public function __construct(ContainerInterface $container)`
`34`	`34`	`$this->container = $container;`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function warmUp(string $cacheDir): array`
	`37`	`+ /**`
	`38`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`39`	`+ * The directory is not provided when only cache_dir should be warmed up.`
	`40`	`+ */`
	`41`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`38`	`42`	`{`
`39`	`43`	`$router = $this->container->get('router');`
`40`	`44`
Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,11 @@ public function __construct(ContainerInterface $container)`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
	`37`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`38`	`+ * The directory is not provided when only cache_dir should be warmed up.`
`37`	`39`	`* @return string[]`
`38`	`40`	`*/`
`39`		`- public function warmUp(string $cacheDir): array`
	`41`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`40`	`42`	`{`
`41`	`43`	`$this->translator ??= $this->container->get('translator');`
`42`	`44`
Original file line number	Diff line number	Diff line change
`@@ -81,9 +81,11 @@ public function getRouteCollection(): RouteCollection`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/**`
	`84`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`85`	`+ * The directory is not provided when only cache_dir should be warmed up.`
`84`	`86`	`* @return string[] A list of classes to preload on PHP 7.4+`
`85`	`87`	`*/`
`86`		`- public function warmUp(string $cacheDir): array`
	`88`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`87`	`89`	`{`
`88`	`90`	`$currentDir = $this->getOption('cache_dir');`
`89`	`91`
Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ public function testCacheIsWarmedWhenCalledTwice()`
`111`	`111`	`$application->doRun($input, new NullOutput());`
`112`	`112`
`113`	`113`	`$this->assertTrue(is_file($this->kernel->getCacheDir().'/dummy.txt'));`
	`114`	`+ $this->assertTrue(is_file($this->kernel->getBuildDir().'/build-dummy.txt'));`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`public function testCacheIsWarmedWithOldContainer()`
Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,12 @@ public function isOptional(): bool`
`52`	`52`	`return false;`
`53`	`53`	`}`
`54`	`54`
`55`		`- public function warmUp(string $cacheDir): array`
	`55`	`+ public function warmUp(string $cacheDir, string $buildDir = null): array`
`56`	`56`	`{`
`57`	`57`	`file_put_contents($cacheDir.'/dummy.txt', 'Hello');`
	`58`	`+ if (null !== $buildDir) {`
	`59`	`+ file_put_contents($buildDir . '/build-dummy.txt', 'Hello');`
	`60`	`+ }`
`58`	`61`
`59`	`62`	`return [];`
`60`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,9 +95,11 @@ public function __construct(ContainerInterface $container, MessageFormatterInter`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
	`98`	`+ * @param string\|null $buildDir directory to put generated source code that can be marked as read-only at runtime.`
	`99`	`+ * The directory is not provided when only cache_dir should be warmed up.`
`98`	`100`	`* @return string[]`
`99`	`101`	`*/`
`100`		`- public function warmUp(string $cacheDir): array`
	`102`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`101`	`103`	`{`
`102`	`104`	`// skip warmUp when translator doesn't use cache`
`103`	`105`	`if (null === $this->options['cache_dir']) {`