Make sure that memoized caches handle (don't set/remove) staged value…

…s from the staging cache.
karptonite · Oct 23, 2024 · 94ad55b · 94ad55b
1 parent 1f08546
commit 94ad55b
Show file tree

Hide file tree

Showing 18 changed files with 248 additions and 22 deletions.
diff --git a/src/Cache/AbstractBaseCache.php b/src/Cache/AbstractBaseCache.php
@@ -22,9 +22,4 @@ protected function callRegenerator(callable $regenerator)
     {
         return $regenerator(false);
     }
-
-    public function getGetCount():int
-    {
-        return 0;
-    }
 }
diff --git a/src/Cache/ArrayCache.php b/src/Cache/ArrayCache.php
@@ -2,7 +2,7 @@
 
 namespace GeekCache\Cache;
 
-class ArrayCache extends AbstractBaseCache implements Cache
+class ArrayCache extends AbstractBaseCache implements CheckableCache
 {
     private $cache = array();
     private $maxputs;
@@ -15,10 +15,10 @@ public function __construct($maxputs = null)
 
     public function get($key, callable $regenerator = null, $ttl = 0)
     {
-        return $this->cacheExists($key) ? $this->cache[$key] : $this->regenerate($key, $regenerator, $ttl);
+        return $this->has($key) ? $this->cache[$key] : $this->regenerate($key, $regenerator, $ttl);
     }
 
-    protected function cacheExists($key)
+    public function has($key): bool
     {
         return array_key_exists($key, $this->cache);
     }
@@ -36,7 +36,7 @@ public function put($key, $value, $ttl = 0)
 
     private function putIsPermitted($key)
     {
-        return !$this->maxputs || $this->putcount < $this->maxputs || $this->cacheExists($key);
+        return !$this->maxputs || $this->putcount < $this->maxputs || $this->has($key);
     }
 
     public function delete($key)
@@ -53,4 +53,13 @@ public function clear()
     public function stage(string $key):void
     {
     }
+
+    public function unstage(string $key):void
+    {
+    }
+
+    public function getGetCount():int
+    {
+        return 0;
+    }
 }
diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php
@@ -5,9 +5,11 @@
 interface Cache
 {
     public function stage(string $key): void;
+    public function unstage(string $key): void;
     public function get($key, callable $regenerator = null, $ttl = 0);
     public function put($key, $value, $ttl = 0);
     public function delete($key);
     public function clear();
+    // the functions below are used only for debugging
     public function getGetCount(): int;
 }
diff --git a/src/Cache/CacheDecorator.php b/src/Cache/CacheDecorator.php
@@ -20,6 +20,11 @@ public function stage(string $key): void
     {
         $this->cache->stage($key);
     }
+
+    public function unstage(string $key): void
+    {
+        $this->cache->unstage($key);
+    }
 
     public function put($key, $value, $ttl = 0)
     {
@@ -35,4 +40,9 @@ public function clear()
     {
         return $this->cache->clear();
     }
+
+    public function getGetCount(): int
+    {
+        return $this->cache->getGetCount();
+    }
 }
diff --git a/src/Cache/CheckableCache.php b/src/Cache/CheckableCache.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace GeekCache\Cache;
+
+interface CheckableCache extends Cache
+{
+    public function has($key): bool;
+}
diff --git a/src/Cache/IncrementableArrayCache.php b/src/Cache/IncrementableArrayCache.php
@@ -2,7 +2,7 @@
 
 namespace GeekCache\Cache;
 
-class IncrementableArrayCache extends ArrayCache implements IncrementableCache
+class IncrementableArrayCache extends ArrayCache implements IncrementableCheckableCache
 {
     public function increment($key, $value = 1, $ttl = 0)
     {
@@ -24,7 +24,7 @@ private function shouldIncrement($value)
 
     private function shouldDecrement($key, $value)
     {
-        return $value < 0 && $this->cacheExists($key);
+        return $value < 0 && $this->has($key);
     }
 
     private function decrementNumber($current, $value)

diff --git a/src/Cache/IncrementableCheckableCache.php b/src/Cache/IncrementableCheckableCache.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace GeekCache\Cache;
+
+interface IncrementableCheckableCache extends CheckableCache, IncrementableCache
+{
+}
diff --git a/src/Cache/IncrementableMemoizedCache.php b/src/Cache/IncrementableMemoizedCache.php
@@ -6,7 +6,7 @@ class IncrementableMemoizedCache extends MemoizedCache implements IncrementableC
 {
     private $incrementablecache;
 
-    public function __construct(IncrementableCache $incrementablecache, Cache $memocache)
+    public function __construct(IncrementableCache $incrementablecache, CheckableCache $memocache)
     {
         parent::__construct($incrementablecache, $memocache);
         $this->incrementablecache = $incrementablecache;

diff --git a/src/Cache/MemoizedCache.php b/src/Cache/MemoizedCache.php
@@ -13,16 +13,27 @@ class MemoizedCache extends CacheDecorator
 {
     private $memocache;
 
-    public function __construct(Cache $primaryCache, Cache $memocache)
+    public function __construct(Cache $primaryCache, CheckableCache $memocache)
     {
         parent::__construct($primaryCache);
         $this->memocache = $memocache;
     }
+
+    public function stage($key):void
+    {
+        if (!$this->memocache->has($key)) {
+            parent::stage($key);
+        }
+    }
 
     public function get($key, callable $regenerator = null, $ttl = 0)
     {
         $result = $this->memocache->get($key);
-        return $result !== false ? $result : $this->getAndMemoize($key, $regenerator, $ttl);
+        if ($result !== false) {
+            parent::unstage($key);
+            return $result;
+        }
+        return $this->getAndMemoize($key, $regenerator, $ttl);
     }
 
     public function put($key, $value, $ttl = 0)

diff --git a/src/Cache/NullCache.php b/src/Cache/NullCache.php
@@ -2,12 +2,17 @@
 
 namespace GeekCache\Cache;
 
-class NullCache implements Cache, IncrementableCache
+class NullCache implements IncrementableCheckableCache
 {
     public function get($key, callable $regenerator = null, $ttl = 0)
     {
         return false;
     }
+
+    public function has($key): bool
+    {
+        return false;
+    }
 
     public function put($key, $value, $ttl = 0)
     {
@@ -37,4 +42,8 @@ public function getGetCount():int
     public function stage(string  $key): void
     {
     }
+
+    public function unstage(string  $key): void
+    {
+    }
 }
diff --git a/src/Cache/StageableCache.php b/src/Cache/StageableCache.php
@@ -20,7 +20,12 @@ public function stage(string $key): void
     {
         $this->stagingCache->stage($key);
     }
-
+
+    public function unstage(string $key): void
+    {
+        $this->stagingCache->unstage($key);
+    }
+
     public function get($key, callable $regenerator = null, $ttl = 0)
     {
         // if we have a pending result, use that

diff --git a/src/Cache/StagingCache.php b/src/Cache/StagingCache.php
@@ -11,6 +11,13 @@ public function stage(string $key): void
         $this->stagedRequests[$key] = ($this->stagedRequests[$key] ?? null) ? $this->stagedRequests[$key] + 1 : 1;
     }
 
+    //fully unstage all counts for key
+    public function unstage(string $key): void
+    {
+        unset($this->stagedRequests[$key]);
+        unset($this->stagedResults[$key]);
+    }
+
     public function resultIsStaged(string $key): bool
     {
         return array_key_exists($key, $this->stagedResults);

diff --git a/src/Counter/CounterBuilder.php b/src/Counter/CounterBuilder.php
@@ -11,7 +11,7 @@ class CounterBuilder
 
     private $stack;
 
-    public function __construct(Cache\IncrementableCache $cache, Cache\IncrementableCache $memocache, array $stack = null)
+    public function __construct(Cache\IncrementableCache $cache, Cache\IncrementableCheckableCache $memocache, array $stack = null)
     {
         $this->cache = $cache;
         $this->memocache = $memocache;

diff --git a/tests/Cache/BaseCacheTest.php b/tests/Cache/BaseCacheTest.php
@@ -14,16 +14,16 @@ public function testGetWithCacheMiss()
     {
         $this->assertCacheReturnsFalseOnCacheMiss($this->cache);
     }
-
+    
     public function testPutAndGet()
     {
         $this->assertCachePutsAndGets($this->cache);
     }
 
     public function testPutReturnsTrueOnSuccess()
     {
-        $result = $this->cache->put( self::KEY, self::VALUE );
-        $this->assertTrue( $result );
+        $result = $this->cache->put(self::KEY, self::VALUE);
+        $this->assertTrue($result);
     }
 
     public function testPutAndGetZero()

diff --git a/tests/Cache/CacheBuilderTest.php b/tests/Cache/CacheBuilderTest.php
@@ -21,7 +21,7 @@ public function tearDown(): void
     public function prepareFullMockBuilder()
     {
         $this->cache         = m::mock('GeekCache\Cache\Cache');
-        $this->memocache     = m::mock('GeekCache\Cache\Cache');
+        $this->memocache     = m::mock('GeekCache\Cache\CheckableCache');
         $this->tagsetfactory = m::mock('GeekCache\Tag\TagSetFactory');
 
         $this->builder = new GeekCache\Cache\CacheBuilder($this->cache, $this->memocache, $this->tagsetfactory);

diff --git a/tests/Cache/TaggedCacheMemcachedTest.php b/tests/Cache/TaggedCacheMemcachedTest.php
@@ -9,6 +9,7 @@ class TaggedCacheMemcachedTest extends BaseCacheTest
 
     const TAG_NAMES = ['TAG_1', 'TAG_2'];
     const TAG_NAMES2 = ['TAG_3', 'TAG_4'];
+    private $parentcache;
 
     public function setUp(): void
     {