[FrameworkBundle] Dont store cache misses on warmup

Nyholm · Nyholm · commit 3cec54ffafc3 · 2021-03-31T00:30:53.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php
@@ -53,10 +53,13 @@ public function warmUp($cacheDir)
             spl_autoload_unregister([ClassExistenceResource::class, 'throwOnRequiredClass']);
         }
 
+        // Remove cache misses (null values)
+        $values = array_filter($arrayAdapter->getValues(), function ($val) { return null !== $val; });
+
         // the ArrayAdapter stores the values serialized
         // to avoid mutation of the data after it was written to the cache
         // so here we un-serialize the values first
-        $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $arrayAdapter->getValues());
+        $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $values);
 
         $this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/AnnotationsCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/AnnotationsCacheWarmerTest.php
@@ -8,6 +8,7 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\AnnotationsCacheWarmer;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\NullAdapter;
 use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
 use Symfony\Component\Cache\DoctrineProvider;
@@ -120,6 +121,36 @@ public function testClassAutoloadExceptionWithUnrelatedException()
         spl_autoload_unregister($classLoader);
     }
 
+    public function testWarmupRemoveCacheMisses()
+    {
+        $cacheFile = tempnam($this->cacheDir, __FUNCTION__);
+        $warmer = $this->getMockBuilder(AnnotationsCacheWarmer::class)
+            ->setConstructorArgs([new AnnotationReader(), $cacheFile])
+            ->onlyMethods(['doWarmUp'])
+            ->getMock();
+
+        $warmer->method('doWarmUp')->willReturnCallback(function ($cacheDir, ArrayAdapter $arrayAdapter) {
+            $arrayAdapter->getItem('foo_miss');
+
+            $item = $arrayAdapter->getItem('bar_hit');
+            $item->set('data');
+            $arrayAdapter->save($item);
+
+            $item = $arrayAdapter->getItem('baz_hit_null');
+            $item->set(null);
+            $arrayAdapter->save($item);
+
+            return true;
+        });
+
+        $warmer->warmUp($this->cacheDir);
+        $data = include $cacheFile;
+
+        $this->assertCount(2, $data[0]);
+        $this->assertTrue(isset($data[0]['bar_hit']));
+        $this->assertTrue(isset($data[0]['baz_hit_null']));
+    }
+
     /**
      * @return MockObject|Reader
      */

Original file line number	Diff line number	Diff line change
`@@ -53,10 +53,13 @@ public function warmUp($cacheDir)`
`53`	`53`	`spl_autoload_unregister([ClassExistenceResource::class, 'throwOnRequiredClass']);`
`54`	`54`	`}`
`55`	`55`
	`56`	`+ // Remove cache misses (null values)`
	`57`	`+ $values = array_filter($arrayAdapter->getValues(), function ($val) { return null !== $val; });`
	`58`	`+`
`56`	`59`	`// the ArrayAdapter stores the values serialized`
`57`	`60`	`// to avoid mutation of the data after it was written to the cache`
`58`	`61`	`// so here we un-serialize the values first`
`59`		`- $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $arrayAdapter->getValues());`
	`62`	`+ $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $values);`
`60`	`63`
`61`	`64`	`$this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);`
`62`	`65`	`}`