add support for the new respect_response_cache_directives configuration

Author: alcohol

CHANGELOG.md

@@ -5,11 +5,22 @@
 ### Added
 
 - The real request method and target url are now displayed in the profiler.
+- Support the cache plugin configuration for `respect_response_cache_directives`.
 
 ### Changed
 
 - The profiler design has been updated.
 
+### Deprecated
+
+- The configuration option `cache.config.respect_cache_headers` should no longer be used. Use `...respect_response_cache_directives` instead.
+
+## 1.4.1 - 2017-02-23
+
+### Fixed
+
+- Make sure we always have a stack
+
 ## 1.4.0 - 2017-02-21
 
 ### Changed

DependencyInjection/Configuration.php

@@ -7,6 +7,7 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
 
 /**
  * This class contains the configuration information for the bundle.
@@ -368,9 +369,35 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
                     ->end()
                     ->arrayNode('config')
                         ->addDefaultsIfNotSet()
+                        ->validate()
+                        ->ifTrue(function ($config) {
+                            // Cannot set both respect_cache_headers and respect_response_cache_directives
+                            return isset($config['respect_cache_headers'], $config['respect_response_cache_directives']);
+                        })
+                        ->thenInvalid('You can\'t provide config option "respect_cache_headers" and "respect_response_cache_directives" simultaniously. Use "respect_response_cache_directives" instead.')
+                        ->end()
                         ->children()
                             ->scalarNode('default_ttl')->defaultValue(0)->end()
-                            ->scalarNode('respect_cache_headers')->defaultNull()->end()
+                            ->enumNode('respect_cache_headers')
+                                ->values([null, true, false])
+                                ->beforeNormalization()
+                                ->always(function ($v) {
+                                    @trigger_error('The option "respect_cache_headers" is deprecated since version 1.3 and will be removed in 2.0. Use "respect_response_cache_directives" instead.', E_USER_DEPRECATED);
+
+                                    return $v;
+                                })
+                                ->end()
+                            ->end()
+                            ->variableNode('respect_response_cache_directives')
+                                ->validate()
+                                ->always(function ($v) {
+                                    if (is_null($v) || is_array($v)) {
+                                        return $v;
+                                    }
+                                    throw new InvalidTypeException();
+                                })
+                                ->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

Tests/Resources/Fixtures/config/bc/cache_config.yml

@@ -0,0 +1,6 @@
+httplug:
+    plugins:
+        cache:
+            cache_pool: my_cache_pool
+            config:
+                respect_cache_headers: true

Tests/Resources/Fixtures/config/full.php

@@ -81,7 +81,7 @@
             'stream_factory' => 'my_other_stream_factory',
             'config' => [
                 'default_ttl' => 42,
-                'respect_cache_headers' => false,
+                'respect_response_cache_directives' => ['X-Foo', 'X-Bar'],
             ],
         ],
         'cookie' => [

Tests/Resources/Fixtures/config/full.xml

@@ -44,7 +44,10 @@
                 <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" respect-cache-headers="false"/>
+                <config default-ttl="42">
+                    <respect-response-cache-directives>X-Foo</respect-response-cache-directives>
+                    <respect-response-cache-directives>X-Bar</respect-response-cache-directives>
+                </config>
             </cache>
             <cookie cookie-jar="my_cookie_jar"/>
             <decoder enabled="false"/>

Tests/Resources/Fixtures/config/full.yml

@@ -56,7 +56,9 @@ httplug:
             stream_factory: my_other_stream_factory
             config:
                 default_ttl: 42
-                respect_cache_headers: false
+                respect_response_cache_directives:
+                  - X-Foo
+                  - X-Bar
         cookie:
             cookie_jar: my_cookie_jar
         decoder:

Tests/Resources/Fixtures/config/invalid_cache_config.yml

@@ -0,0 +1,9 @@
+httplug:
+    plugins:
+        cache:
+            cache_pool: my_cache_pool
+            config:
+                respect_cache_headers: true
+                respect_response_cache_directives:
+                  - X-Foo
+                  - X-Bar

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -36,8 +36,7 @@ class ConfigurationTest extends AbstractExtensionConfigurationTestCase
                 'enabled' => false,
                 'stream_factory' => 'httplug.stream_factory',
                 'config' => [
-                    'default_ttl' => null,
-                    'respect_cache_headers' => null,
+                    'default_ttl' => 0,
                 ],
             ],
             'cookie' => [
@@ -196,7 +195,7 @@ public function testSupportsAllConfigFormats()
                     'stream_factory' => 'my_other_stream_factory',
                     'config' => [
                         'default_ttl' => 42,
-                        'respect_cache_headers' => false,
+                        'respect_response_cache_directives' => ['X-Foo', 'X-Bar'],
                     ],
                 ],
                 'cookie' => [
@@ -279,13 +278,24 @@ public function testInvalidAuthentication()
         $this->assertProcessedConfigurationEquals([], [$file]);
     }
 
+    /**
+     * @group legacy
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedExceptionMessage Invalid configuration for path "httplug.plugins.cache.config": You can't provide config option "respect_cache_headers" and "respect_response_cache_directives" simultaniously. Use "respect_response_cache_directives" instead.
+     */
+    public function testInvalidCacheConfig()
+    {
+        $file = __DIR__.'/../../Resources/Fixtures/config/invalid_cache_config.yml';
+        $this->assertProcessedConfigurationEquals([], [$file]);
+    }
+
     /**
      * @group legacy
      */
     public function testBackwardCompatibility()
     {
         $formats = array_map(function ($path) {
-            return __DIR__.'/../../Resources/Fixtures//'.$path;
+            return __DIR__.'/../../Resources/Fixtures/'.$path;
         }, [
             'config/bc/toolbar.yml',
             'config/bc/toolbar_auto.yml',
@@ -296,6 +306,24 @@ public function testBackwardCompatibility()
         }
     }
 
+    /**
+     * @group legacy
+     */
+    public function testCacheConfigDeprecationCompatibility()
+    {
+        $file = __DIR__.'/../../Resources/Fixtures/config/bc/cache_config.yml';
+        $config = $this->emptyConfig;
+        $config['plugins']['cache'] = array_merge($config['plugins']['cache'], [
+            'enabled' => true,
+            'cache_pool' => 'my_cache_pool',
+            'config' => [
+                'default_ttl' => 0,
+                'respect_cache_headers' => true,
+            ],
+        ]);
+        $this->assertProcessedConfigurationEquals($config, [$file]);
+    }
+
     /**
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      * @expectedExceptionMessage Can't configure both "toolbar" and "profiling" section. The "toolbar" config is deprecated as of version 1.3.0, please only use "profiling".

composer.json

@@ -20,7 +20,7 @@
         "php-http/client-implementation": "^1.0",
         "php-http/message-factory": "^1.0.2",
         "php-http/client-common": "^1.2",
-        "php-http/cache-plugin": "^1.3",
+        "php-http/cache-plugin": "^1.4",
         "php-http/logger-plugin": "^1.0",
         "php-http/stopwatch-plugin": "^1.0",
         "symfony/options-resolver": "^2.8 || ^3.0",