Wrapped php-http/cache-plugin option blacklisted_paths (#362)

* Wrapped php-http/cache-plugin option blacklisted_paths
 - list of regular expressions to match paths not to be cached.

* Allow any regex delimiter

Co-authored-by: Tobias Nyholm <[email protected]>

Author: schroedingerskatze42

CHANGELOG.md

@@ -10,6 +10,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 `blacklisted_paths` option of `php-http/cache-plugin`
 
 ### Changed
 

composer.json

@@ -49,7 +49,7 @@
         "guzzlehttp/psr7": "^1.0",
         "matthiasnoback/symfony-dependency-injection-test": "^4.0",
         "nyholm/nsa": "^1.1",
-        "php-http/cache-plugin": "^1.6",
+        "php-http/cache-plugin": "^1.7",
         "php-http/guzzle6-adapter": "^1.1.1 || ^2.0.1",
         "php-http/mock-client": "^1.2",
         "php-http/promise": "^1.0",

src/DependencyInjection/Configuration.php

@@ -721,6 +721,21 @@ private function createCachePluginNode()
                 ->integerNode('default_ttl')
                     ->info('The default max age of a Response')
                 ->end()
+                ->arrayNode('blacklisted_paths')
+                    ->info('An array of regular expression patterns for paths not to be cached. Defaults to an empty array.')
+                    ->defaultValue([])
+                    ->beforeNormalization()
+                        ->castToArray()
+                    ->end()
+                    ->prototype('scalar')
+                        ->validate()
+                            ->ifTrue(function ($v) {
+                                return false === @preg_match($v, '');
+                            })
+                            ->thenInvalid('Invalid regular expression for a blacklisted path: %s')
+                        ->end()
+                    ->end()
+                ->end()
                 ->enumNode('hash_algo')
                     ->info('Hashing algorithm to use')
                     ->values(hash_algos())

src/DependencyInjection/HttplugExtension.php

@@ -207,6 +207,10 @@ private function configurePluginByName($name, Definition $definition, array $con
                     $options['cache_key_generator'] = new Reference($options['cache_key_generator']);
                 }
 
+                if (empty($options['blacklisted_paths'])) {
+                    unset($options['blacklisted_paths']);
+                }
+
                 $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'],
+                'blacklisted_paths' => ['@/path/not-to-be/cached@']
             ],
         ],
         'cookie' => [

tests/Resources/Fixtures/config/full.xml

@@ -57,6 +57,7 @@
                 <config default-ttl="42" cache-lifetime="2592000" hash-algo="sha1" cache-key-generator="null">
                     <respect-response-cache-directive>X-Foo</respect-response-cache-directive>
                     <method>GET</method>
+                    <blacklisted-paths>@/path/not-to-be/cached@</blacklisted-paths>
                 </config>
             </cache>
             <cookie cookie-jar="my_cookie_jar"/>

tests/Resources/Fixtures/config/full.yml

@@ -73,6 +73,8 @@ httplug:
                 cache_key_generator: null
                 respect_response_cache_directives:
                   - X-Foo
+                blacklisted_paths:
+                  - '@/path/not-to-be/cached@'
         cookie:
             cookie_jar: my_cookie_jar
         decoder:

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -45,6 +45,7 @@ class ConfigurationTest extends AbstractExtensionConfigurationTestCase
                 'stream_factory' => 'httplug.stream_factory',
                 'config' => [
                     'methods' => ['GET', 'HEAD'],
+                    'blacklisted_paths' => [],
                 ],
             ],
             'cookie' => [
@@ -235,6 +236,7 @@ public function testSupportsAllConfigFormats(): void
                         'methods' => ['GET'],
                         'cache_key_generator' => null,
                         'respect_response_cache_directives' => ['X-Foo'],
+                        'blacklisted_paths' => ['@/path/not-to-be/cached@'],
                     ],
                 ],
                 'cookie' => [
@@ -356,6 +358,7 @@ public function testCacheConfigDeprecationCompatibility(): void
             'config' => [
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => true,
+                'blacklisted_paths' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);
@@ -374,6 +377,7 @@ public function testCacheConfigDeprecationCompatibilityIssue166(): void
             'config' => [
                 'methods' => ['GET', 'HEAD'],
                 'respect_cache_headers' => false,
+                'blacklisted_paths' => [],
             ],
         ]);
         $this->assertProcessedConfigurationEquals($config, [$file]);