[Cache] Pass arg to get callback everywhere

symfony · nicolas-grekas · Jun 6, 2019 · Jun 5, 2019 · Jun 6, 2019 · d03eb033bb413f310cdbe89005ba1b4ee7a88943
commit d03eb033bb413f310cdbe89005ba1b4ee7a88943
diff --git a/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php
@@ -59,7 +59,8 @@ public function get(string $key, callable $callback, float $beta = null, array &

        // ArrayAdapter works in memory, we don't care about stampede protection
        if (INF === $beta || !$item->isHit()) {
-            $this->save($item->set($callback($item)));
+            $save = true;
+            $this->save($item->set($callback($item, $save)));
        }

        return $item->get();

diff --git a/src/Symfony/Component/Cache/Adapter/NullAdapter.php b/src/Symfony/Component/Cache/Adapter/NullAdapter.php
@@ -42,7 +42,9 @@ function ($key) {
     */
    public function get(string $key, callable $callback, float $beta = null, array &$metadata = null)
    {
-        return $callback(($this->createCacheItem)($key));
+        $save = true;
+
+        return $callback(($this->createCacheItem)($key), $save);
    }

    /**

diff --git a/src/Symfony/Component/Cache/Adapter/ProxyAdapter.php b/src/Symfony/Component/Cache/Adapter/ProxyAdapter.php
@@ -103,9 +103,9 @@ public function get(string $key, callable $callback, float $beta = null, array &
            return $this->doGet($this, $key, $callback, $beta, $metadata);
        }

-        return $this->pool->get($this->getId($key), function ($innerItem) use ($key, $callback) {
+        return $this->pool->get($this->getId($key), function ($innerItem, bool &$save) use ($key, $callback) {
            $item = ($this->createCacheItem)($key, $innerItem);
-            $item->set($value = $callback($item));
+            $item->set($value = $callback($item, $save));
            ($this->setInnerItem)($innerItem, (array) $item);

            return $value;

diff --git a/src/Symfony/Component/Cache/Adapter/TraceableAdapter.php b/src/Symfony/Component/Cache/Adapter/TraceableAdapter.php
@@ -45,10 +45,10 @@ public function get(string $key, callable $callback, float $beta = null, array &
        }

        $isHit = true;
-        $callback = function (CacheItem $item) use ($callback, &$isHit) {
+        $callback = function (CacheItem $item, bool &$save) use ($callback, &$isHit) {
            $isHit = $item->isHit();

-            return $callback($item);
+            return $callback($item, $save);
        };

        $event = $this->start(__FUNCTION__);

diff --git a/src/Symfony/Component/Cache/Tests/Adapter/AdapterTestCase.php b/src/Symfony/Component/Cache/Tests/Adapter/AdapterTestCase.php
@@ -12,9 +12,12 @@
 namespace Symfony\Component\Cache\Tests\Adapter;

 use Cache\IntegrationTests\CachePoolTest;
+use PHPUnit\Framework\Assert;
+use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Contracts\Cache\CallbackInterface;

 abstract class AdapterTestCase extends CachePoolTest
 {
@@ -57,6 +60,22 @@ public function testGet()
            $this->assertSame($value, $item->get());
        }, INF));
        $this->assertFalse($isHit);
+
+        $this->assertSame($value, $cache->get('bar', new class($value) implements CallbackInterface {
+            private $value;
+
+            public function __construct(int $value)
+            {
+                $this->value = $value;
+            }
+
+            public function __invoke(CacheItemInterface $item, bool &$save)
+            {
+                Assert::assertSame('bar', $item->getKey());
+
+                return $this->value;
+            }
+        }));
    }

    public function testRecursiveGet()