Skip to content

Commit

Permalink
bug #31879 [Cache] Pass arg to get callback everywhere (fancyweb)
Browse files Browse the repository at this point in the history
This PR was merged into the 4.2 branch.

Discussion
----------

[Cache] Pass  arg to get callback everywhere

| Q             | A
| ------------- | ---
| Branch?       | 4.2
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Some adapters does not pass an useless "save" bool arg. However, that makes a `CallbackInterface` callable unusable with them since the arg is required in the interface.

Commits
-------

d03eb03 [Cache] Pass  arg to get callback everywhere
  • Loading branch information
nicolas-grekas committed Jun 6, 2019
2 parents eb41911 + d03eb03 commit 687f775
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 6 deletions.
3 changes: 2 additions & 1 deletion src/Symfony/Component/Cache/Adapter/ArrayAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
4 changes: 3 additions & 1 deletion src/Symfony/Component/Cache/Adapter/NullAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Cache/Adapter/ProxyAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Cache/Adapter/TraceableAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -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__);
Expand Down
19 changes: 19 additions & 0 deletions src/Symfony/Component/Cache/Tests/Adapter/AdapterTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -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()
Expand Down

0 comments on commit 687f775

Please sign in to comment.