Merge pull request #92 from julienloizelet/fix/custom-handler-memcached-tag-aware

Fix/custom handler memcached tag aware

Author: julienloizelet

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## [0.22.1] - 2022-06-03
+
+### Fixed
+- Handle custom error handler for Memcached tag aware adapter
+
 ## [0.22.0] - 2022-06-02
 
 ### Added

scripts/refresh-cache.php

@@ -14,7 +14,7 @@
 
 // Instantiate the "PhpFilesAdapter" cache adapter
 $cacheAdapter = new TagAwareAdapter(new Symfony\Component\Cache\Adapter\PhpFilesAdapter('', 0, $cachePath));
-// 0Or Redis: $cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://your-redis-host:6379'));
+// Or Redis: $cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://your-redis-host:6379'));
 // Or Memcached: $cacheAdapter = new TagAwareAdapter(new MemcachedAdapter(MemcachedAdapter::createConnection
 //('memcached://your-memcached-host:11211')));
 // Parse argument

src/ApiCache.php

@@ -4,6 +4,7 @@
 
 namespace CrowdSecBouncer;
 
+use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use DateTime;
 use Exception;
 use IPLib\Address\AddressInterface;
@@ -13,7 +14,6 @@
 use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
-use Symfony\Component\Cache\Adapter\MemcachedAdapter;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
@@ -826,7 +826,7 @@ public function prune(): bool
      */
     private function setCustomErrorHandler(): void
     {
-        if ($this->adapter instanceof MemcachedAdapter) {
+        if ($this->adapter instanceof MemcachedTagAwareAdapter) {
             set_error_handler(function ($errno, $errstr) {
                 throw new BouncerException("Error when connecting to Memcached. (Error level: $errno) Please fix the Memcached DSN or select another cache technology. Original message was: $errstr");
             });
@@ -838,7 +838,7 @@ private function setCustomErrorHandler(): void
      * */
     private function unsetCustomErrorHandler(): void
     {
-        if ($this->adapter instanceof MemcachedAdapter) {
+        if ($this->adapter instanceof MemcachedTagAwareAdapter) {
             restore_error_handler();
         }
     }

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.22.0';
+    public const VERSION = 'v0.22.1';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/'.self::VERSION;

src/Fixes/Memcached/TagAwareAdapter.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace CrowdSecBouncer\Fixes\Memcached;
+
+use Symfony\Component\Cache\Adapter\TagAwareAdapter as SymfonyTagAwareAdapter;
+// This class is used only to know explicitly that we instantiiate a Memcached adapter
+class TagAwareAdapter extends SymfonyTagAwareAdapter
+{
+
+}

src/StandaloneBounce.php

@@ -2,6 +2,7 @@
 
 namespace CrowdSecBouncer;
 
+use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use ErrorException;
 use Exception;
 use IPLib\Factory;
@@ -92,7 +93,7 @@ private function getCacheAdapterInstance(bool $forceReload = false): TagAwareAda
                     throw new BouncerException('The selected cache technology is Memcached.'.' Please set a Memcached DSN or select another cache technology.');
                 }
 
-                $this->cacheAdapter = new TagAwareAdapter(
+                $this->cacheAdapter = new MemcachedTagAwareAdapter(
                     new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedDsn)));
                 break;
 

tests/IpVerificationTest.php

@@ -60,18 +60,30 @@ public function testCanVerifyIpInLiveModeWithCacheSystem($cacheAdapter, $origCac
         $bouncer = new Bouncer(null, $this->logger, $apiCache);
         $bouncer->configure($bouncerConfig);
 
-        if (in_array($origCacheName, ['PhpFilesAdapter', 'MemcachedAdapter'])) {
-            $this->assertEquals(
-                'Symfony\Component\Cache\Adapter\TagAwareAdapter',
-                get_class($cacheAdapter),
-                'Tested adapter should be correct'
-            );
-        } elseif ('RedisAdapter' == $origCacheName) {
-            $this->assertEquals(
-                'Symfony\Component\Cache\Adapter\RedisTagAwareAdapter',
-                get_class($cacheAdapter),
-                'Tested adapter should be correct'
-            );
+        switch ($origCacheName) {
+            case 'PhpFilesAdapter':
+                $this->assertEquals(
+                    'Symfony\Component\Cache\Adapter\TagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            case 'MemcachedAdapter':
+                $this->assertEquals(
+                    'CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            case 'RedisAdapter':
+                $this->assertEquals(
+                    'Symfony\Component\Cache\Adapter\RedisTagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            default:
+                break;
         }
 
         // At the end of test, we should have exactly 3 "cache miss")
@@ -167,20 +179,31 @@ public function testCanVerifyIpInStreamModeWithCacheSystem($cacheAdapter, $origC
         $bouncer = new Bouncer(null, $this->logger, $apiCache);
         $bouncer->configure($bouncerConfig);
 
-        if (in_array($origCacheName, ['PhpFilesAdapter', 'MemcachedAdapter'])) {
-            $this->assertEquals(
-                'Symfony\Component\Cache\Adapter\TagAwareAdapter',
-                get_class($cacheAdapter),
-                'Tested adapter should be correct'
-            );
-        } elseif ('RedisAdapter' == $origCacheName) {
-            $this->assertEquals(
-                'Symfony\Component\Cache\Adapter\RedisTagAwareAdapter',
-                get_class($cacheAdapter),
-                'Tested adapter should be correct'
-            );
+        switch ($origCacheName) {
+            case 'PhpFilesAdapter':
+                $this->assertEquals(
+                    'Symfony\Component\Cache\Adapter\TagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            case 'MemcachedAdapter':
+                $this->assertEquals(
+                    'CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            case 'RedisAdapter':
+                $this->assertEquals(
+                    'Symfony\Component\Cache\Adapter\RedisTagAwareAdapter',
+                    get_class($cacheAdapter),
+                    'Tested adapter should be correct'
+                );
+                break;
+            default:
+                break;
         }
-
         // As we are in stream mode, no live call should be done to the API.
 
         /** @var MockObject $apiClientMock */
@@ -269,7 +292,7 @@ public function testCanVerifyIpInStreamModeWithCacheSystem($cacheAdapter, $origC
         $this->assertEquals(
             'ban',
             $bouncer->getRemediationForIp(TestHelpers::NEWLY_BAD_IP),
-            'The cache warm up should be stored across each instanciation'
+            'The cache warm up should be stored across each instantiation'
         );
 
         $this->logger->info('', ['message' => 'set "Large IPV4 range banned" + "IPV6 range banned" state']);

tests/TestHelpers.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
@@ -56,7 +57,7 @@ public static function cacheAdapterProvider(): array
 
         /** @var string */
         $memcachedCacheAdapterDsn = getenv('MEMCACHED_DSN');
-        $memcachedAdapter = new TagAwareAdapter(
+        $memcachedAdapter = new MemcachedTagAwareAdapter(
             new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedCacheAdapterDsn)));
 
         return [