Merge pull request #112 from julienloizelet/feat/no-tag-for-memcached

Feat/no tag for memcached

Author: julienloizelet

src/AbstractCache.php

@@ -4,12 +4,12 @@
 
 namespace CrowdSecBouncer;
 
-use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use DateTime;
 use ErrorException;
 use Exception;
 use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Cache\Adapter\MemcachedAdapter;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
@@ -31,7 +31,7 @@
 abstract class AbstractCache
 {
     public const CACHE_SEP = '_';
-    /** @var TagAwareAdapter|MemcachedTagAwareAdapter|RedisTagAwareAdapter */
+    /** @var AdapterInterface */
     protected $adapter;
     /**
      * @var ApiClient
@@ -125,9 +125,9 @@ public function __construct(
     }
 
     /**
-     * @return TagAwareAdapterInterface
+     * @return AdapterInterface
      */
-    public function getAdapter(): TagAwareAdapterInterface
+    public function getAdapter(): AdapterInterface
     {
         return $this->adapter;
     }
@@ -290,7 +290,9 @@ protected function addRemediationToCacheItem(
 
         $item->set($prioritizedRemediations);
         $item->expiresAt(new DateTime('@' . $maxLifetime));
-        $item->tag(Constants::CACHE_TAG_REM);
+        if ($this->adapter instanceof TagAwareAdapterInterface) {
+            $item->tag(Constants::CACHE_TAG_REM);
+        }
 
         // Save the cache without committing it to the cache system.
         // Useful to improve performance when updating the cache.
@@ -457,7 +459,7 @@ protected function removeDecisionFromRemediationItem(string $cacheKey, int $deci
                 'type' => 'CACHE_ITEM_REMOVED',
                 'cache_key' => $cacheKey,
             ]);
-            $this->adapter->delete(base64_encode($cacheKey));
+            $this->adapter->deleteItem(base64_encode($cacheKey));
 
             return true;
         }
@@ -466,7 +468,9 @@ protected function removeDecisionFromRemediationItem(string $cacheKey, int $deci
         $cacheContent = Remediation::sortRemediationByPriority($remediations);
         $item->expiresAt(new DateTime('@' . $maxLifetime));
         $item->set($cacheContent);
-        $item->tag(Constants::CACHE_TAG_REM);
+        if ($this->adapter instanceof TagAwareAdapterInterface) {
+            $item->tag(Constants::CACHE_TAG_REM);
+        }
 
         // Save the cache without committing it to the cache system.
         // Useful to improve performance when updating the cache.
@@ -497,7 +501,9 @@ protected function saveCacheItem(string $cacheTag, string $cacheKey, $cachedVari
         $item = $this->adapter->getItem(base64_encode($cacheKey));
         $item->set($cachedVariables);
         $item->expiresAt(new DateTime("+$duration seconds"));
-        $item->tag($cacheTag);
+        if ($this->adapter instanceof TagAwareAdapterInterface) {
+            $item->tag($cacheTag);
+        }
         $this->adapter->save($item);
     }
 
@@ -508,7 +514,7 @@ protected function saveCacheItem(string $cacheTag, string $cacheKey, $cachedVari
      */
     protected function setCustomErrorHandler(): void
     {
-        if ($this->adapter instanceof MemcachedTagAwareAdapter) {
+        if ($this->adapter instanceof MemcachedAdapter) {
             set_error_handler(function ($errno, $errstr) {
                 $message = "Error when connecting to Memcached. (Error level: $errno)" .
                            "Please fix the Memcached DSN or select another cache technology." .
@@ -523,7 +529,7 @@ protected function setCustomErrorHandler(): void
      * */
     protected function unsetCustomErrorHandler(): void
     {
-        if ($this->adapter instanceof MemcachedTagAwareAdapter) {
+        if ($this->adapter instanceof MemcachedAdapter) {
             restore_error_handler();
         }
     }
@@ -552,10 +558,11 @@ private function configureAdapter(): void
                     throw new BouncerException('The selected cache technology is Memcached.' .
                                                ' Please set a Memcached DSN or select another cache technology.');
                 }
-
-                $this->adapter = new MemcachedTagAwareAdapter(
-                    new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedDsn))
-                );
+                /**
+                 * Using a MemcachedAdapter with a TagAwareAdapter for storing tags is discouraged.
+                 * @see \Symfony\Component\Cache\Adapter\MemcachedAdapter::__construct comment
+                 */
+                $this->adapter = new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedDsn));
                 break;
 
             case Constants::CACHE_SYSTEM_REDIS:

src/Bouncer.php

@@ -14,7 +14,7 @@
 use Monolog\Logger;
 use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Config\Definition\Processor;
 
@@ -150,7 +150,7 @@ public function getApiCache(): ApiCache
         return $this->apiCache;
     }
 
-    public function getCacheAdapter(): TagAwareAdapterInterface
+    public function getCacheAdapter(): AdapterInterface
     {
         return $this->getApiCache()->getAdapter();
     }

src/Fixes/Memcached/TagAwareAdapter.php

@@ -48,7 +48,7 @@ private function cacheAdapterCheck($cacheAdapter, $origCacheName)
                 break;
             case 'MemcachedAdapter':
                 $this->assertEquals(
-                    'CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter',
+                    'Symfony\Component\Cache\Adapter\MemcachedAdapter',
                     get_class($cacheAdapter),
                     'Tested adapter should be correct'
                 );

tests/Integration/IpVerificationTest.php

@@ -5,15 +5,9 @@
 namespace CrowdSecBouncer\Tests\Integration;
 
 use CrowdSecBouncer\Constants;
-use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
-use Symfony\Component\Cache\Adapter\MemcachedAdapter;
-use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
-use Symfony\Component\Cache\Adapter\RedisAdapter;
-use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
-use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\Exception\CacheException;
 
 class TestHelpers