Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 51f39b9

Browse files
fabpotfabpot
committed
feature #28718 [Cache] add CacheInterface::delete() + improve CacheTrait (nicolas-grekas)
This PR was merged into the 4.2-dev branch. Discussion ---------- [Cache] add CacheInterface::delete() + improve CacheTrait | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - I've been hesitating a lot on this topic, but I think we should add a `delete()` method to `CacheInterface`. Deleting is a very common invalidation strategy and invalidating by passing `$beta=INF` to `get()` has the drawback of requiring a fetch+unserialize+save-with-past-expiration. That's complexity that a delete removes. This PR fixes an issue found meanwhile on `get()`: passing an `ItemInterface` to its callback makes it harder than required to implement on top of PSR-6. Let's pass a `CacheItemInterface`. Lastly, the early expiration logic can be moved from the component to the trait shipped on contracts. Here we are for all these steps. Commits ------- c6cf690 [Cache] add CacheInterface::delete() + improve CacheTrait
2 parents 52b7239 + c6cf690 commit 51f39b9

15 files changed

+203
-121
lines changed

‎src/Symfony/Component/Cache/Adapter/AbstractAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
use Symfony\Component\Cache\Exception\InvalidArgumentException;
2020
use Symfony\Component\Cache\ResettableInterface;
2121
use Symfony\Component\Cache\Traits\AbstractTrait;
22-
use Symfony\Component\Cache\Traits\GetTrait;
22+
use Symfony\Component\Cache\Traits\ContractsTrait;
2323
use Symfony\Contracts\Cache\CacheInterface;
2424

2525
/**
@@ -28,7 +28,7 @@
2828
abstract class AbstractAdapter implements AdapterInterface, CacheInterface, LoggerAwareInterface, ResettableInterface
2929
{
3030
use AbstractTrait;
31-
use GetTrait;
31+
use ContractsTrait;
3232

3333
private static $apcuSupported;
3434
private static $phpFilesSupported;

‎src/Symfony/Component/Cache/Adapter/ArrayAdapter.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,12 @@ public function commit()
151151
{
152152
return true;
153153
}
154+
155+
/**
156+
* {@inheritdoc}
157+
*/
158+
public function delete(string $key): bool
159+
{
160+
return $this->deleteItem($key);
161+
}
154162
}

‎src/Symfony/Component/Cache/Adapter/ChainAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
use Symfony\Component\Cache\Exception\InvalidArgumentException;
1818
use Symfony\Component\Cache\PruneableInterface;
1919
use Symfony\Component\Cache\ResettableInterface;
20-
use Symfony\Component\Cache\Traits\GetTrait;
20+
use Symfony\Component\Cache\Traits\ContractsTrait;
2121
use Symfony\Contracts\Cache\CacheInterface;
2222
use Symfony\Contracts\Service\ResetInterface;
2323

@@ -31,7 +31,7 @@
3131
*/
3232
class ChainAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
3333
{
34-
use GetTrait;
34+
use ContractsTrait;
3535

3636
private $adapters = array();
3737
private $adapterCount;

‎src/Symfony/Component/Cache/Adapter/NullAdapter.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,14 @@ public function commit()
119119
return false;
120120
}
121121

122+
/**
123+
* {@inheritdoc}
124+
*/
125+
public function delete(string $key): bool
126+
{
127+
return $this->deleteItem($key);
128+
}
129+
122130
private function generateItems(array $keys)
123131
{
124132
$f = $this->createCacheItem;

‎src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
use Symfony\Component\Cache\Exception\InvalidArgumentException;
1818
use Symfony\Component\Cache\PruneableInterface;
1919
use Symfony\Component\Cache\ResettableInterface;
20-
use Symfony\Component\Cache\Traits\GetTrait;
20+
use Symfony\Component\Cache\Traits\ContractsTrait;
2121
use Symfony\Component\Cache\Traits\PhpArrayTrait;
2222
use Symfony\Contracts\Cache\CacheInterface;
2323

@@ -31,7 +31,7 @@
3131
class PhpArrayAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
3232
{
3333
use PhpArrayTrait;
34-
use GetTrait;
34+
use ContractsTrait;
3535

3636
private $createCacheItem;
3737

‎src/Symfony/Component/Cache/Adapter/ProxyAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use Symfony\Component\Cache\CacheItem;
1717
use Symfony\Component\Cache\PruneableInterface;
1818
use Symfony\Component\Cache\ResettableInterface;
19-
use Symfony\Component\Cache\Traits\GetTrait;
19+
use Symfony\Component\Cache\Traits\ContractsTrait;
2020
use Symfony\Component\Cache\Traits\ProxyTrait;
2121
use Symfony\Contracts\Cache\CacheInterface;
2222

@@ -26,7 +26,7 @@
2626
class ProxyAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
2727
{
2828
use ProxyTrait;
29-
use GetTrait;
29+
use ContractsTrait;
3030

3131
private $namespace;
3232
private $namespaceLen;

‎src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use Symfony\Component\Cache\CacheItem;
1717
use Symfony\Component\Cache\PruneableInterface;
1818
use Symfony\Component\Cache\ResettableInterface;
19-
use Symfony\Component\Cache\Traits\GetTrait;
19+
use Symfony\Component\Cache\Traits\ContractsTrait;
2020
use Symfony\Component\Cache\Traits\ProxyTrait;
2121
use Symfony\Contracts\Cache\TagAwareCacheInterface;
2222

@@ -28,7 +28,7 @@ class TagAwareAdapter implements TagAwareAdapterInterface, TagAwareCacheInterfac
2828
const TAGS_PREFIX = "\0tags\0";
2929

3030
use ProxyTrait;
31-
use GetTrait;
31+
use ContractsTrait;
3232

3333
private $deferred = array();
3434
private $createCacheItem;

‎src/Symfony/Component/Cache/Adapter/TraceableAdapter.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,19 @@ public function reset()
237237
}
238238
}
239239

240+
/**
241+
* {@inheritdoc}
242+
*/
243+
public function delete(string $key): bool
244+
{
245+
$event = $this->start(__FUNCTION__);
246+
try {
247+
return $event->result[$key] = $this->pool->deleteItem($key);
248+
} finally {
249+
$event->end = microtime(true);
250+
}
251+
}
252+
240253
public function getCalls()
241254
{
242255
return $this->calls;

‎src/Symfony/Component/Cache/Traits/GetTrait.php renamed to ‎src/Symfony/Component/Cache/Traits/ContractsTrait.php

Lines changed: 19 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,20 @@
1616
use Symfony\Component\Cache\Exception\InvalidArgumentException;
1717
use Symfony\Component\Cache\LockRegistry;
1818
use Symfony\Contracts\Cache\CacheInterface;
19+
use Symfony\Contracts\Cache\CacheTrait;
1920
use Symfony\Contracts\Cache\ItemInterface;
2021

2122
/**
2223
* @author Nicolas Grekas <[email protected]>
2324
*
2425
* @internal
2526
*/
26-
trait GetTrait
27+
trait ContractsTrait
2728
{
29+
use CacheTrait {
30+
doGet as private contractsGet;
31+
}
32+
2833
private $callbackWrapper = array(LockRegistry::class, 'compute');
2934

3035
/**
@@ -42,47 +47,12 @@ public function setCallbackWrapper(callable $callbackWrapper): callable
4247
return $previousWrapper;
4348
}
4449

45-
/**
46-
* {@inheritdoc}
47-
*/
48-
public function get(string $key, callable $callback, float $beta = null)
49-
{
50-
return $this->doGet($this, $key, $callback, $beta);
51-
}
52-
5350
private function doGet(AdapterInterface $pool, string $key, callable $callback, ?float $beta)
5451
{
5552
if (0 > $beta = $beta ?? 1.0) {
5653
throw new InvalidArgumentException(sprintf('Argument "$beta" provided to "%s::get()" must be a positive number, %f given.', \get_class($this), $beta));
5754
}
5855

59-
$t = 0;
60-
$item = $pool->getItem($key);
61-
$recompute = !$item->isHit() || INF === $beta;
62-
63-
if (0 < $beta) {
64-
if ($recompute) {
65-
$t = microtime(true);
66-
} else {
67-
$metadata = $item->getMetadata();
68-
$expiry = $metadata[ItemInterface::METADATA_EXPIRY] ?? false;
69-
$ctime = $metadata[ItemInterface::METADATA_CTIME] ?? false;
70-
71-
if ($ctime && $expiry) {
72-
$t = microtime(true);
73-
$recompute = $expiry <= $t - $ctime / 1000 * $beta * log(random_int(1, PHP_INT_MAX) / PHP_INT_MAX);
74-
}
75-
}
76-
if ($recompute) {
77-
// force applying defaultLifetime to expiry
78-
$item->expiresAt(null);
79-
}
80-
}
81-
82-
if (!$recompute) {
83-
return $item->get();
84-
}
85-
8656
static $save;
8757

8858
$save = $save ?? \Closure::bind(
@@ -99,16 +69,19 @@ function (AdapterInterface $pool, ItemInterface $item, $value, float $startTime)
9969
CacheItem::class
10070
);
10171

102-
// don't wrap nor save recursive calls
103-
if (null === $callbackWrapper = $this->callbackWrapper) {
104-
return $callback($item);
105-
}
106-
$this->callbackWrapper = null;
72+
return $this->contractsGet($pool, $key, function (CacheItem $item) use ($pool, $callback, $save) {
73+
// don't wrap nor save recursive calls
74+
if (null === $callbackWrapper = $this->callbackWrapper) {
75+
return $callback($item);
76+
}
77+
$this->callbackWrapper = null;
78+
$t = microtime(true);
10779

108-
try {
109-
return $save($pool, $item, $callbackWrapper($item, $callback, $pool), $t);
110-
} finally {
111-
$this->callbackWrapper = $callbackWrapper;
112-
}
80+
try {
81+
return $save($pool, $item, $callbackWrapper($item, $callback, $pool), $t);
82+
} finally {
83+
$this->callbackWrapper = $callbackWrapper;
84+
}
85+
}, $beta);
11386
}
11487
}

‎src/Symfony/Contracts/Cache/CacheInterface.php

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,46 @@
1111

1212
namespace Symfony\Contracts\Cache;
1313

14+
use Psr\Cache\CacheItemInterface;
1415
use Psr\Cache\InvalidArgumentException;
1516

1617
/**
17-
* Gets/Stores items from/to a cache.
18-
*
19-
* On cache misses, a callback is called that should return the missing value.
20-
* This callback is given an ItemInterface object corresponding to the needed key,
21-
* that could be used e.g. for expiration control.
18+
* Covers most simple to advanced caching needs.
2219
*
2320
* @author Nicolas Grekas <[email protected]>
2421
*/
2522
interface CacheInterface
2623
{
2724
/**
28-
* @param string $key The key of the item to retrieve from the cache
29-
* @param callable(ItemInterface):mixed $callback Should return the computed value for the given key/item
30-
* @param float|null $beta A float that, as it grows, controls the likeliness of triggering
31-
* early expiration. 0 disables it, INF forces immediate expiration.
32-
* The default (or providing null) is implementation dependent but should
33-
* typically be 1.0, which should provide optimal stampede protection.
34-
* See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
25+
* Fetches a value from the pool or computes it if not found.
26+
*
27+
* On cache misses, a callback is called that should return the missing value.
28+
* This callback is given a PSR-6 CacheItemInterface instance corresponding to the
29+
* requested key, that could be used e.g. for expiration control. It could also
30+
* be an ItemInterface instance when its additional features are needed.
31+
*
32+
* @param string $key The key of the item to retrieve from the cache
33+
* @param callable(CacheItemInterface):mixed $callback Should return the computed value for the given key/item
34+
* @param float|null $beta A float that, as it grows, controls the likeliness of triggering
35+
* early expiration. 0 disables it, INF forces immediate expiration.
36+
* The default (or providing null) is implementation dependent but should
37+
* typically be 1.0, which should provide optimal stampede protection.
38+
* See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
3539
*
3640
* @return mixed The value corresponding to the provided key
3741
*
3842
* @throws InvalidArgumentException When $key is not valid or when $beta is negative
3943
*/
4044
public function get(string $key, callable $callback, float $beta = null);
45+
46+
/**
47+
* Removes an item from the pool.
48+
*
49+
* @param string $key The key to delete
50+
*
51+
* @throws InvalidArgumentException When $key is not valid
52+
*
53+
* @return bool True if the item was successfully removed, false if there was any error
54+
*/
55+
public function delete(string $key): bool;
4156
}

0 commit comments

Comments
 (0)