Add caching support

egeloen · Sep 20, 2015 · 8a98333 · 8a98333
1 parent 6e1da2c
commit 8a98333
Show file tree

Hide file tree

Showing 12 changed files with 280 additions and 3 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -32,7 +32,7 @@ public function getConfigTreeBuilder()
             ->beforeNormalization()
                 ->always(function ($config) {
                     if (empty($config['adapters'])) {
-                        $config['adapters'] = array('default' => array('type' => 'socket'));
+                        $config['adapters'] = ['default' => ['type' => 'socket']];
                     }
 
                     if (!isset($config['default'])) {
@@ -101,6 +101,7 @@ private function createSubscribersNode()
             ->canBeEnabled()
             ->children()
                 ->append($this->createBasicAuthSubscriberNode())
+                ->append($this->createCacheSubscriberNode())
                 ->append($this->createRedirectSubscriberNode())
                 ->scalarNode('cookie')->end()
                 ->scalarNode('history')->end()
@@ -126,6 +127,21 @@ private function createBasicAuthSubscriberNode()
             ->end();
     }
 
+    /**
+     * Creates the cache subscriber node.
+     *
+     * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The cache subscriber node.
+     */
+    private function createCacheSubscriberNode()
+    {
+        return $this->createNode('cache')
+            ->children()
+                ->scalarNode('adapter')->isRequired()->end()
+                ->integerNode('lifetime')->defaultValue(null)->end()
+                ->booleanNode('exception')->defaultValue(true)->end()
+            ->end();
+    }
+
     /**
      * Creates the redirect subscriber node.
      *
@@ -146,7 +162,7 @@ private function createRedirectSubscriberNode()
      *
      * @param string $name The node name.
      *
-     * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The node.
+     * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition|\Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition The node.
      */
     private function createNode($name)
     {

diff --git a/DependencyInjection/IvoryHttpAdapterExtension.php b/DependencyInjection/IvoryHttpAdapterExtension.php
@@ -224,6 +224,10 @@ private function createSubscriberDefinition(
                 $this->configureBasicAuthSubscriberDefinition($subscriber, $configuration, $adapterName, $container);
                 break;
 
+            case 'cache':
+                $this->configureCacheSubscriberDefinition($subscriber, $configuration, $adapterName, $container);
+                break;
+
             case 'cookie':
                 $this->configureCookieSubscriberDefinition($subscriber, $configuration);
                 break;
@@ -277,6 +281,27 @@ private function configureBasicAuthSubscriberDefinition(
         $subscriber->setArguments(array(new Reference($service)));
     }
 
+    /**
+     * Configures the cache subscriber definition.
+     *
+     * @param \Symfony\Component\DependencyInjection\Definition       $subscriber  The subscriber.
+     * @param array                                                   $cache       The cache.
+     * @param string                                                  $adapterName The adapter name.
+     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container   The container.
+     */
+    private function configureCacheSubscriberDefinition(
+        Definition $subscriber,
+        array $cache,
+        $adapterName,
+        ContainerBuilder $container
+    ) {
+        $model = new DefinitionDecorator(self::createServiceName('subscriber.cache.model'));
+        $model->setArguments(array(new Reference($cache['adapter']), null, $cache['lifetime'], $cache['exception']));
+
+        $container->setDefinition($service = self::createServiceName($adapterName.'.cache.model'), $model);
+        $subscriber->setArguments(array(new Reference($service)));
+    }
+
     /**
      * Configures the cookie subscriber definition.
      *

diff --git a/Resources/config/subscribers/cache.xml b/Resources/config/subscribers/cache.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"
+>
+    <services>
+        <service
+            id="ivory.http_adapter.subscriber.cache.model"
+            class="Ivory\HttpAdapter\Event\Cache\Cache"
+            abstract="true"
+        />
+
+        <service
+            id="ivory.http_adapter.subscriber.cache"
+            class="Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber"
+            abstract="true"
+        />
+    </services>
+</container>
diff --git a/Resources/doc/usage.md b/Resources/doc/usage.md
@@ -81,6 +81,8 @@ ivory_http_adapter:
         basic_auth:
             username: egeloen
             password: pass
+        cache:
+            adapter: your.adapter.service
         cookie: ~
         history: ~
         logger: ~
@@ -108,6 +110,8 @@ ivory_http_adapter:
                 basic_auth:
                     username: egeloen
                     password: pass
+                cache:
+                    adapter: your.adapter.service
                 cookie: ~
                 history: ~
                 logger: ~
@@ -140,6 +144,25 @@ basic_auth:
     matcher: my-domain.com
 ```
 
+### Cache subscriber
+
+The cache subscriber requires you to create a cache adapter service which is an implementation of
+`Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface`. When it is created, just configure it:
+
+``` yaml
+# ...
+cache:
+    adapter: your.adapter.service
+```
+
+You can also specify if the exceptions should be cached (enabled by default):
+
+``` yaml
+# ...
+cache:
+    exception: false
+```
+
 ### Cookie subscriber
 
 The cookie subscriber can use different jar implementation according to your needs. To use the file one:

diff --git a/Tests/DependencyInjection/AbstractIvoryHttpAdapterExtensionTest.php b/Tests/DependencyInjection/AbstractIvoryHttpAdapterExtensionTest.php
@@ -223,6 +223,81 @@ public function testGlobalBasicAuthSubscriberWithMatcher()
         $this->assertSame('domain.com', $basicAuth->getMatcher());
     }
 
+    public function testGlobalCacheSubscriber()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'global_cache');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.default.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.default.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertTrue($listener->getCache()->cacheException());
+    }
+
+    public function testGlobalCacheSubscriberWithoutException()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'global_cache_without_exception');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.default.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.default.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertFalse($listener->getCache()->cacheException());
+    }
+
+    public function testGlobalCacheSubscriberWithLifetime()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'global_cache_with_lifetime');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.default.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.default.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertSame(100, $listener->getCache()->getLifetime());
+    }
+
     public function testGlobalCookieSubscriber()
     {
         $this->container->setParameter('kernel.cache_dir', sys_get_temp_dir());
@@ -604,6 +679,81 @@ public function testLocalBasicAuthSubscriberWithMatcher()
         );
     }
 
+    public function testLocalCacheSubscriber()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'local_cache');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.local.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.local.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertTrue($listener->getCache()->cacheException());
+    }
+
+    public function testLocalCacheSubscriberWithoutException()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'local_cache_without_exception');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.local.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.local.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertFalse($listener->getCache()->cacheException());
+    }
+
+    public function testLocalCacheSubscriberWithLifetime()
+    {
+        $this->container->set(
+            'ivory.cache.adapter',
+            $cacheAdapter = $this->getMock('Ivory\HttpAdapter\Event\Cache\Adapter\CacheAdapterInterface')
+        );
+
+        $this->loadConfiguration($this->container, 'local_cache_with_lifetime');
+        $this->container->compile();
+
+        $listener = $this->assertListener(
+            $this->container->get('ivory.http_adapter.local.event_dispatcher'),
+            Events::REQUEST_CREATED,
+            'Ivory\HttpAdapter\Event\Subscriber\CacheSubscriber'
+        );
+
+        $this->assertSame(
+            $cache = $this->container->get('ivory.http_adapter.local.cache.model'),
+            $listener->getCache()
+        );
+
+        $this->assertSame($cacheAdapter, $listener->getCache()->getAdapter());
+        $this->assertSame(100, $listener->getCache()->getLifetime());
+    }
+
     public function testLocalCookieSubscriber()
     {
         $this->container->setParameter('kernel.cache_dir', sys_get_temp_dir());

diff --git a/Tests/Fixtures/config/Yaml/global_cache.yml b/Tests/Fixtures/config/Yaml/global_cache.yml
@@ -0,0 +1,4 @@
+ivory_http_adapter:
+    subscribers:
+        cache:
+            adapter: ivory.cache.adapter
diff --git a/Tests/Fixtures/config/Yaml/global_cache_with_lifetime.yml b/Tests/Fixtures/config/Yaml/global_cache_with_lifetime.yml
@@ -0,0 +1,5 @@
+ivory_http_adapter:
+    subscribers:
+        cache:
+            adapter: ivory.cache.adapter
+            lifetime: 100
diff --git a/Tests/Fixtures/config/Yaml/global_cache_without_exception.yml b/Tests/Fixtures/config/Yaml/global_cache_without_exception.yml
@@ -0,0 +1,5 @@
+ivory_http_adapter:
+    subscribers:
+        cache:
+            adapter: ivory.cache.adapter
+            exception: false
diff --git a/Tests/Fixtures/config/Yaml/local_cache.yml b/Tests/Fixtures/config/Yaml/local_cache.yml
@@ -0,0 +1,9 @@
+ivory_http_adapter:
+    adapters:
+        global:
+            type: socket
+        local:
+            type: socket
+            subscribers:
+                cache:
+                    adapter: ivory.cache.adapter
diff --git a/Tests/Fixtures/config/Yaml/local_cache_with_lifetime.yml b/Tests/Fixtures/config/Yaml/local_cache_with_lifetime.yml
@@ -0,0 +1,10 @@
+ivory_http_adapter:
+    adapters:
+        global:
+            type: socket
+        local:
+            type: socket
+            subscribers:
+                cache:
+                    adapter: ivory.cache.adapter
+                    lifetime: 100
diff --git a/Tests/Fixtures/config/Yaml/local_cache_without_exception.yml b/Tests/Fixtures/config/Yaml/local_cache_without_exception.yml
@@ -0,0 +1,10 @@
+ivory_http_adapter:
+    adapters:
+        global:
+            type: socket
+        local:
+            type: socket
+            subscribers:
+                cache:
+                    adapter: ivory.cache.adapter
+                    exception: false
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     ],
     "require": {
         "php": ">=5.4.8",
-        "egeloen/http-adapter": "^0.8",
+        "egeloen/http-adapter": "^0.8@dev",
         "symfony/framework-bundle": "^2.2"
     },
     "require-dev": {