[FrameworkBundle] Make SerializeCacheWarmer use kernel.build_dir instead of cache_dir

okhoshi · okhoshi · commit 38a2688097b8 · 2023-12-09T23:37:23.000+01:00
Signed-off-by: Quentin Devos &lt;4972091+Okhoshi@users.noreply.github.com&gt;
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Remove `AbstractPhpFileCacheWarmer`'s constructor argument, override new `getPhpArrayFile` method instead
  * Make `ValidatorCacheWarmer` use `kernel.build_dir` instead of `cache_dir`
+ * Make `SerializeCacheWarmer` use `kernel.build_dir` instead of `cache_dir`
 
 7.0
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/SerializerCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/SerializerCacheWarmer.php
@@ -28,18 +28,27 @@ class SerializerCacheWarmer extends AbstractPhpFileCacheWarmer
 {
     private array $loaders;
 
+    private string $phpArrayFile;
+
     /**
      * @param LoaderInterface[] $loaders      The serializer metadata loaders
      * @param string            $phpArrayFile The PHP file where metadata are cached
      */
     public function __construct(array $loaders, string $phpArrayFile)
     {
-        parent::__construct($phpArrayFile);
+        if ($phpArrayFile !== basename($phpArrayFile)) {
+            trigger_deprecation('symfony/framework-bundle', '7.1', 'Providing more than a filename to "string $phpArrayFile" argument is deprecated. The argument will be considered as a filename in 8.0.');
+        }
+        parent::__construct();
         $this->loaders = $loaders;
+        $this->phpArrayFile = $phpArrayFile;
     }
 
     protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter, string $buildDir = null): bool
     {
+        if (!$buildDir) {
+            return false;
+        }
         if (!$this->loaders) {
             return true;
         }
@@ -59,6 +68,18 @@ protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter, string
         return true;
     }
 
+    protected function getPhpArrayFile(string $cacheDir, string $buildDir = null): ?string
+    {
+        if (!$buildDir) {
+            return null;
+        }
+        if ($this->phpArrayFile !== basename($this->phpArrayFile)) {
+            return $this->phpArrayFile;
+        }
+
+        return $buildDir.\DIRECTORY_SEPARATOR.$this->phpArrayFile;
+    }
+
     /**
      * @param LoaderInterface[] $loaders
      *
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php
@@ -54,7 +54,7 @@
 
 return static function (ContainerConfigurator $container) {
     $container->parameters()
-        ->set('serializer.mapping.cache.file', '%kernel.cache_dir%/serialization.php')
+        ->set('serializer.mapping.cache.file', 'serialization.php')
     ;
 
     $container->services()
@@ -160,7 +160,10 @@
 
         ->set('serializer.mapping.cache.symfony', CacheItemPoolInterface::class)
             ->factory([PhpArrayAdapter::class, 'create'])
-            ->args([param('serializer.mapping.cache.file'), service('cache.serializer')])
+            ->args([
+                param('kernel.build_dir').'/'.param('serializer.mapping.cache.file'),
+                service('cache.serializer'),
+            ])
 
         ->set('serializer.mapping.cache_class_metadata_factory', CacheClassMetadataFactory::class)
             ->decorate('serializer.mapping.class_metadata_factory')
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/SerializerCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/SerializerCacheWarmerTest.php
@@ -29,8 +29,8 @@ public function testWarmUp(array $loaders)
         $file = sys_get_temp_dir().'/cache-serializer.php';
         @unlink($file);
 
-        $warmer = new SerializerCacheWarmer($loaders, $file);
-        $warmer->warmUp(\dirname($file));
+        $warmer = new SerializerCacheWarmer($loaders, basename($file));
+        $warmer->warmUp(\dirname($file), \dirname($file));
 
         $this->assertFileExists($file);
 
@@ -40,6 +40,25 @@ public function testWarmUp(array $loaders)
         $this->assertTrue($arrayPool->getItem('Symfony_Bundle_FrameworkBundle_Tests_Fixtures_Serialization_Author')->isHit());
     }
 
+    /**
+     * @dataProvider loaderProvider
+     */
+    public function testWarmUpWithoutBuildDir(array $loaders)
+    {
+        $file = sys_get_temp_dir().'/cache-serializer.php';
+        @unlink($file);
+
+        $warmer = new SerializerCacheWarmer($loaders, basename($file));
+        $warmer->warmUp(\dirname($file));
+
+        $this->assertFileDoesNotExist($file);
+
+        $arrayPool = new PhpArrayAdapter($file, new NullAdapter());
+
+        $this->assertTrue($arrayPool->getItem('Symfony_Bundle_FrameworkBundle_Tests_Fixtures_Serialization_Person')->isHit());
+        $this->assertTrue($arrayPool->getItem('Symfony_Bundle_FrameworkBundle_Tests_Fixtures_Serialization_Author')->isHit());
+    }
+
     public static function loaderProvider(): array
     {
         return [
@@ -65,8 +84,8 @@ public function testWarmUpWithoutLoader()
         $file = sys_get_temp_dir().'/cache-serializer-without-loader.php';
         @unlink($file);
 
-        $warmer = new SerializerCacheWarmer([], $file);
-        $warmer->warmUp(\dirname($file));
+        $warmer = new SerializerCacheWarmer([], basename($file));
+        $warmer->warmUp(\dirname($file), \dirname($file));
 
         $this->assertFileExists($file);
     }
@@ -79,15 +98,19 @@ public function testClassAutoloadException()
     {
         $this->assertFalse(class_exists($mappedClass = 'AClassThatDoesNotExist_FWB_CacheWarmer_SerializerCacheWarmerTest', false));
 
-        $warmer = new SerializerCacheWarmer([new YamlFileLoader(__DIR__.'/../Fixtures/Serialization/Resources/does_not_exist.yaml')], tempnam(sys_get_temp_dir(), __FUNCTION__));
+        $file = tempnam(sys_get_temp_dir(), __FUNCTION__);
+        @unlink($file);
+
+        $warmer = new SerializerCacheWarmer([new YamlFileLoader(__DIR__.'/../Fixtures/Serialization/Resources/does_not_exist.yaml')], basename($file));
 
         spl_autoload_register($classLoader = function ($class) use ($mappedClass) {
             if ($class === $mappedClass) {
                 throw new \DomainException('This exception should be caught by the warmer.');
             }
         }, true, true);
 
-        $warmer->warmUp('foo');
+        $warmer->warmUp(\dirname($file), \dirname($file));
+        $this->assertFileExists($file);
 
         spl_autoload_unregister($classLoader);
     }
@@ -103,7 +126,10 @@ public function testClassAutoloadExceptionWithUnrelatedException()
 
         $this->assertFalse(class_exists($mappedClass = 'AClassThatDoesNotExist_FWB_CacheWarmer_SerializerCacheWarmerTest', false));
 
-        $warmer = new SerializerCacheWarmer([new YamlFileLoader(__DIR__.'/../Fixtures/Serialization/Resources/does_not_exist.yaml')], tempnam(sys_get_temp_dir(), __FUNCTION__));
+        $file = tempnam(sys_get_temp_dir(), __FUNCTION__);
+        @unlink($file);
+
+        $warmer = new SerializerCacheWarmer([new YamlFileLoader(__DIR__.'/../Fixtures/Serialization/Resources/does_not_exist.yaml')], basename($file));
 
         spl_autoload_register($classLoader = function ($class) use ($mappedClass) {
             if ($class === $mappedClass) {
@@ -112,8 +138,12 @@ public function testClassAutoloadExceptionWithUnrelatedException()
             }
         }, true, true);
 
-        $warmer->warmUp('foo');
+        try {
+            $warmer->warmUp(\dirname($file), \dirname($file));
+        } finally {
+            $this->assertFileDoesNotExist($file);
 
-        spl_autoload_unregister($classLoader);
+            spl_autoload_unregister($classLoader);
+        }
     }
 }
