Merge pull request #361 from nobYsDarling/master

Adding Support for cache-plugins cache_listeners

Author: dbu

src/DependencyInjection/Configuration.php

@@ -5,6 +5,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;
@@ -719,6 +720,7 @@ private function createCachePluginNode()
         $config
             ->fixXmlConfig('method')
             ->fixXmlConfig('respect_response_cache_directive')
+            ->fixXmlConfig('cache_listener')
             ->addDefaultsIfNotSet()
             ->validate()
                 ->ifTrue(function ($config) {
@@ -770,6 +772,12 @@ private function createCachePluginNode()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('cache_listeners')
+                    ->info('A list of service ids to act on the response based on the results of the cache check. Must implement '.CacheListener::class.'. Defaults to an empty array.')
+                    ->beforeNormalization()->castToArray()->end()
+                    ->prototype('scalar')
+                    ->end()
+                ->end()
                 ->scalarNode('respect_cache_headers')
                     ->info('Whether we should care about cache headers or not [DEPRECATED]')
                     ->beforeNormalization()

src/DependencyInjection/HttplugExtension.php

@@ -213,6 +213,14 @@ private function configurePluginByName($name, Definition $definition, array $con
                     unset($options['blacklisted_paths']);
                 }
 
+                $options['cache_listeners'] = array_map(function (string $serviceName): Reference {
+                    return new Reference($serviceName);
+                }, $options['cache_listeners']);
+
+                if (0 === 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

@@ -109,7 +109,11 @@
                 'methods' => ['GET'],
                 'cache_key_generator' => null,
                 'respect_response_cache_directives' => ['X-Foo'],
-                'blacklisted_paths' => ['@/path/not-to-be/cached@']
+                'blacklisted_paths' => ['@/path/not-to-be/cached@'],
+                'cache_listeners' => [
+                    'my_cache_listener_0',
+                    'my_cache_listener_1',
+                ],
             ],
         ],
         'cookie' => [

tests/Resources/Fixtures/config/full.xml

@@ -62,6 +62,8 @@
             </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">
+                    <cache-listener>my_cache_listener_0</cache-listener>
+                    <cache-listener>my_cache_listener_1</cache-listener>
                     <respect-response-cache-directive>X-Foo</respect-response-cache-directive>
                     <method>GET</method>
                     <blacklisted-paths>@/path/not-to-be/cached@</blacklisted-paths>

tests/Resources/Fixtures/config/full.yml

@@ -82,6 +82,9 @@ httplug:
                   - X-Foo
                 blacklisted_paths:
                   - '@/path/not-to-be/cached@'
+                cache_listeners:
+                  - my_cache_listener_0
+                  - my_cache_listener_1
         cookie:
             cookie_jar: my_cookie_jar
         decoder:

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -63,6 +63,7 @@ class ConfigurationTest extends AbstractExtensionConfigurationTestCase
                 'config' => [
                     'methods' => ['GET', 'HEAD'],
                     'blacklisted_paths' => [],
+                    'cache_listeners' => [],
                 ],
             ],
             'cookie' => [
@@ -268,6 +269,10 @@ public function testSupportsAllConfigFormats(): void
                         'cache_key_generator' => null,
                         'respect_response_cache_directives' => ['X-Foo'],
                         'blacklisted_paths' => ['@/path/not-to-be/cached@'],
+                        'cache_listeners' => [
+                            'my_cache_listener_0',
+                            'my_cache_listener_1',
+                        ],
                     ],
                 ],
                 'cookie' => [
@@ -390,6 +395,7 @@ public function testCacheConfigDeprecationCompatibility(): void
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => true,
                 'blacklisted_paths' => [],
+                'cache_listeners' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);
@@ -409,6 +415,7 @@ public function testCacheConfigDeprecationCompatibilityIssue166(): void
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => false,
                 'blacklisted_paths' => [],
+                'cache_listeners' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);

tests/Unit/DependencyInjection/HttplugExtensionTest.php

@@ -263,6 +263,29 @@ 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' => [
+                            'httplug.plugin.cache.listeners.add_header',
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+
+        $cachePlugin = $this->container->findDefinition('httplug.plugin.cache');
+
+        $config = $cachePlugin->getArgument(2);
+        $this->assertArrayHasKey('cache_listeners', $config);
+        $this->assertContainsOnlyInstancesOf(Reference::class, $config['cache_listeners']);
+        $this->assertSame('httplug.plugin.cache.listeners.add_header', (string) $config['cache_listeners'][0]);
+    }
+
     public function testContentTypePluginAllowedOptions(): void
     {
         $this->load([