Adding Support for cache-plugins cache_listeners

CHANGELOG.md

@@ -9,6 +9,7 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 - Configured clients are now tagged with `'httplug.client'`
 - Adds a link to profiler page when response is from a Symfony application with
   profiler enabled
+- Adding `cache_listeners` option of `php-http/cache-plugin`
 
 ### Changed
 

src/DependencyInjection/Configuration.php

@@ -3,6 +3,7 @@
 namespace Http\HttplugBundle\DependencyInjection;
 
 use Http\Client\Common\Plugin\Cache\Generator\CacheKeyGenerator;
+use Http\Client\Common\Plugin\Cache\Listener\CacheListener;
 use Http\Client\Common\Plugin\CachePlugin;
 use Http\Client\Common\Plugin\Journal;
 use Http\Client\Plugin\Vcr\NamingStrategy\NamingStrategyInterface;
@@ -13,6 +14,7 @@
 use Http\Message\StreamFactory;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
+use ReflectionClass;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -739,6 +741,27 @@ private function createCachePluginNode()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('cache_listeners')
+                    ->info('An array of classes to act on the response based on the results of the cache check. Must implement '.CacheListener::class.'. Defaults to an empty array.')
+                    ->beforeNormalization()->castToArray()->ifEmpty()->thenUnset()->end()
+                    ->defaultValue([])
+                    ->prototype('scalar')
+                        ->validate()
+                            ->ifTrue(function ($v) {
+                                $vs = is_array($v) ? $v : (is_null($v) ? [] : [$v]);
+
+                                return empty($vs) || array_reduce($vs, function ($r, $e) {
+                                    return empty($e) || !class_exists($e) || !(new ReflectionClass($e))->implementsInterface(CacheListener::class);
+                                }, false);
+                            })
+                            ->thenInvalid('A given listener class does not implement '.CacheListener::class)
+                        ->end()
+                    ->end()
+                    ->validate()
+                        ->ifEmpty()
+                        ->thenUnset()
+                    ->end()
+                ->end()
                 ->scalarNode('respect_cache_headers')
                     ->info('Whether we should care about cache headers or not [DEPRECATED]')
                     ->beforeNormalization()

src/DependencyInjection/HttplugExtension.php

@@ -203,10 +203,22 @@ private function configurePluginByName($name, Definition $definition, array $con
         switch ($name) {
             case 'cache':
                 $options = $config['config'];
+
                 if (!empty($options['cache_key_generator'])) {
                     $options['cache_key_generator'] = new Reference($options['cache_key_generator']);
                 }
 
+                if (!empty($options['cache_listeners'])) {
+                    foreach ($options['cache_listeners'] as $i => $listener) {
+                        if (!empty($listener)) {
+                            $options['cache_listeners'][$i] = new Definition($listener);
+                        }
+                    }
+                }
+                if (!count($options['cache_listeners'])) {
+                    unset($options['cache_listeners']);
+                }
+
                 $definition
                     ->replaceArgument(0, new Reference($config['cache_pool']))
                     ->replaceArgument(1, new Reference($config['stream_factory']))

tests/Resources/Fixtures/config/full.php

@@ -102,6 +102,7 @@
                 'methods' => ['GET'],
                 'cache_key_generator' => null,
                 'respect_response_cache_directives' => ['X-Foo'],
+                'cache_listeners' => [],
             ],
         ],
         'cookie' => [

tests/Resources/Fixtures/config/full.xml

@@ -54,7 +54,7 @@
                 <my_service type="service" service="my_auth_service"/>
             </authentication>
             <cache cache-pool="my_cache_pool" stream-factory="my_other_stream_factory">
-                <config default-ttl="42" cache-lifetime="2592000" hash-algo="sha1" cache-key-generator="null">
+                <config default-ttl="42" cache-lifetime="2592000" hash-algo="sha1" cache-key-generator="null" cache-listeners="">
                     <respect-response-cache-directive>X-Foo</respect-response-cache-directive>
                     <method>GET</method>
                 </config>

tests/Resources/Fixtures/config/full.yml

@@ -73,6 +73,7 @@ httplug:
                 cache_key_generator: null
                 respect_response_cache_directives:
                   - X-Foo
+                cache_listeners: []
         cookie:
             cookie_jar: my_cookie_jar
         decoder:

tests/Resources/Fixtures/config/invalid_cache_listener_config.yml

@@ -0,0 +1,6 @@
+httplug:
+    plugins:
+        cache:
+            cache_pool: my_cache_pool
+            config:
+                cache_listeners: ['NotExistentClass']

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -2,6 +2,7 @@
 
 namespace Http\HttplugBundle\Tests\Unit\DependencyInjection;
 
+use Http\Client\Common\Plugin\Cache\Listener\CacheListener;
 use Http\HttplugBundle\DependencyInjection\Configuration;
 use Http\HttplugBundle\DependencyInjection\HttplugExtension;
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionConfigurationTestCase;
@@ -43,6 +44,7 @@ class ConfigurationTest extends AbstractExtensionConfigurationTestCase
                 'stream_factory' => 'httplug.stream_factory',
                 'config' => [
                     'methods' => ['GET', 'HEAD'],
+                    'cache_listeners' => [],
                 ],
             ],
             'cookie' => [
@@ -233,6 +235,7 @@ public function testSupportsAllConfigFormats(): void
                         'methods' => ['GET'],
                         'cache_key_generator' => null,
                         'respect_response_cache_directives' => ['X-Foo'],
+                        'cache_listeners' => [],
                     ],
                 ],
                 'cookie' => [
@@ -354,6 +357,7 @@ public function testCacheConfigDeprecationCompatibility(): void
             'config' => [
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => true,
+                'cache_listeners' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);
@@ -372,6 +376,7 @@ public function testCacheConfigDeprecationCompatibilityIssue166(): void
             'config' => [
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => false,
+                'cache_listeners' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);
@@ -420,4 +425,14 @@ public function testInvalidCapturedBodyLengthString(): void
         $this->expectExceptionMessage('The child node "captured_body_length" at path "httplug.profiling" must be an integer or null');
         $this->assertProcessedConfigurationEquals([], [$file]);
     }
+
+    public function testInvalidCacheConfigCacheListeners(): void
+    {
+        $file = __DIR__.'/../../Resources/Fixtures/config/invalid_cache_listener_config.yml';
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('A given listener class does not implement '.CacheListener::class);
+
+        $this->assertProcessedConfigurationEquals($this->emptyConfig, [$file]);
+    }
 }

tests/Unit/DependencyInjection/HttplugExtensionTest.php

@@ -7,6 +7,7 @@
 use Http\HttplugBundle\Collector\PluginClientFactoryListener;
 use Http\HttplugBundle\DependencyInjection\HttplugExtension;
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\Kernel;
 use Http\Adapter\Guzzle6\Client;
@@ -261,6 +262,47 @@ public function testCachePluginConfigCacheKeyGeneratorReference(): void
         $this->assertSame('header_cache_key_generator', (string) $config['cache_key_generator']);
     }
 
+    public function testCachePluginConfigCacheListenersDefinition(): void
+    {
+        $this->load([
+            'plugins' => [
+                'cache' => [
+                    'cache_pool' => 'my_cache_pool',
+                    'config' => [
+                        'cache_listeners' => [
+                            '\Http\Client\Common\Plugin\Cache\Listener\AddHeaderCacheListener',
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+
+        $cachePlugin = $this->container->findDefinition('httplug.plugin.cache');
+
+        $config = $cachePlugin->getArgument(2);
+        $this->assertArrayHasKey('cache_listeners', $config);
+        $this->assertContainsOnlyInstancesOf(Definition::class, $config['cache_listeners']);
+    }
+
+    public function testCachePluginInvalidConfigCacheListenersDefinition(): void
+    {
+        $this->load([
+            'plugins' => [
+                'cache' => [
+                    'cache_pool' => 'my_cache_pool',
+                    'config' => [
+                        'cache_listeners' => [],
+                    ],
+                ],
+            ],
+        ]);
+
+        $cachePlugin = $this->container->findDefinition('httplug.plugin.cache');
+
+        $config = $cachePlugin->getArgument(2);
+        $this->assertArrayNotHasKey('cache_listeners', $config);
+    }
+
     public function testContentTypePluginAllowedOptions(): void
     {
         $this->load([