Implement the plan(TM)

* Add priorities so that new custom ResourceCheckers can be run first * Provide a default ResourceChecker with a very low priority that will validate through ResourceInterface::isFresh() but triggers a deprecation warning. * Add a new interface that extends ResourceInterface and contains the isFresh() method. * Add a ResourceChecker for this interface with a slightly higher priority and without deprecation warning. * Make FileResource et. al. implement the new interface. * Deprecate ResourceInterface::isFresh() but keep that method in the new interface subclass.
symfony · bnw · Sep 3, 2015 · Sep 4, 2015 · Sep 4, 2015 · Sep 4, 2015
commit f5add4c419634e0e0024b6412bf119eb8fd4f653
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/ConfigCachePass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/ConfigCachePass.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Adds services tagged config_cache.resource_checker to the config_cache_factory service, ordering them by priority.
+ *
+ * @author Matthias Pigulla <mp@webfactory.de>
+ * @author Benjamin Klotz <bk@webfactory.de>
+ */
+class ConfigCachePass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $resourceCheckers = array();
+        foreach ($container->findTaggedServiceIds('config_cache.resource_checker') as $id => $attributes) {
+            $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;
+            $resourceCheckers[$priority][] = new Reference($id);
+        }
+
+        // sort by priority and flatten
+        krsort($resourceCheckers);
+        $resourceCheckers = call_user_func_array('array_merge', $resourceCheckers);
+
+        $container->getDefinition('config_cache_factory')->addMethodCall('setResourceCheckers', array($resourceCheckers));
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -28,7 +28,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationExtractorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationDumperPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass;
-use Symfony\Component\Config\DependencyInjection\ConfigCachePass;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ConfigCachePass;
 use Symfony\Component\Debug\ErrorHandler;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml
@@ -13,8 +13,9 @@
         <parameter key="file_locator.class">Symfony\Component\HttpKernel\Config\FileLocator</parameter>
         <parameter key="uri_signer.class">Symfony\Component\HttpKernel\UriSigner</parameter>
         <parameter key="request_stack.class">Symfony\Component\HttpFoundation\RequestStack</parameter>
-        <parameter key="config_cache_factory.class">Symfony\Component\Config\ValidatorConfigCacheFactory</parameter>
-        <parameter key="config_cache_default_validator.class">Symfony\Component\Config\Resource\ResourceValidator</parameter>
+        <parameter key="config_cache_factory.class">Symfony\Component\Config\ResourceCheckerConfigCacheFactory</parameter>
+        <parameter key="config_cache_default_resource_checker.class">Symfony\Component\Config\Resource\DefaultResourceChecker</parameter>
+        <parameter key="config_cache_bc_resource_interface_checker.class">Symfony\Component\Config\Resource\BCResourceInterfaceChecker</parameter>
     </parameters>
 
     <services>
@@ -66,12 +67,18 @@
             <argument>%kernel.secret%</argument>
         </service>
 
-        <service id="config_cache_factory" class="%config_cache_factory.class%">
-            <argument>%kernel.debug%</argument>
+        <service id="config_cache_factory" class="%config_cache_factory.class%" />
+
+        <service id="config_cache_default_resource_checker" class="%config_cache_default_resource_checker.class%">
+            <tag name="config_cache.resource_checker" priority="-990" />
         </service>
 
-        <service id="config_cache_default_validator" class="%config_cache_default_validator.class%">
-            <tag name="config_cache.metadata_validato
6D40
r" />
+        <!--
+            This service is deprecated and will be removed in 3.0.
+        -->
+        <service id="config_cache_bc_resource_interface_checker" class="%config_cache_bc_resource_interface_checker.class%">
+            <tag name="config_cache.resource_checker" priority="-1000" />
         </service>
+
     </services>
 </container>
diff --git a/...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/ConfigCachePassTest.php b/...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/ConfigCachePassTest.php
@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ConfigCachePass;
+
+class ConfigCachePassTest extends \PHPUnit_Framework_TestCase
+{
+    public function testThatCheckersAreProcessedInPriorityOrder()
+    {
+        $services = array(
+            'checker_2' => array(0 => array('priority' => 100)),
+            'checker_1' => array(0 => array('priority' => 200)),
+            'checker_3' => array(),
+        );
+
+        $definition = $this->getMock('Symfony\Component\DependencyInjection\Definition');
+        $container = $this->getMock(
+            'Symfony\Component\DependencyInjection\ContainerBuilder',
+            array('findTaggedServiceIds', 'getDefinition', 'hasDefinition')
+        );
+
+        $container->expects($this->atLeastOnce())
+            ->method('findTaggedServiceIds')
+            ->will($this->returnValue($services));
+        $container->expects($this->atLeastOnce())
+            ->method('getDefinition')
+            ->with('config_cache_factory')
+            ->will($this->returnValue($definition));
+
+        $definition->expects($this->once())
+            ->method('addMethodCall')
+            ->with('setResourceCheckers', array(
+                array(
+                    new Reference('checker_1'),
+                    new Reference('checker_2'),
+                    new Reference('checker_3'),
+                )
+            ));
+
+        $pass = new ConfigCachePass();
+        $pass->process($container);
+    }
+}
diff --git a/src/Symfony/Component/Config/ConfigCache.php b/src/Symfony/Component/Config/ConfigCache.php
@@ -11,19 +11,25 @@
 
 namespace Symfony\Component\Config;
 
-use Symfony\Component\Config\Resource\ResourceValidator;
+use Symfony\Component\Config\Resource\BCResourceInterfaceChecker;
+use Symfony\Component\Config\Resource\DefaultResourceChecker;
 
 /**
  * ConfigCache caches arbitrary content in files on disk.
  *
  * When in debug mode, those metadata resources that implement
- * \Symfony\Component\Config\Resource\ResourceInterface will
+ * \Symfony\Component\Config\Resource\SelfCheckingResourceInterface will
  * be used to check cache freshness.
  *
+ * During a transition period, also instances of
+ * \Symfony\Component\Config\Resource\ResourceInterface will be checked
+ * by means of the isFresh() method. This behaviour is deprecated since 2.8
+ * and will be removed in 3.0.
+ *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Matthias Pigulla <mp@webfactory.de>
  */
-class ConfigCache extends ValidatorConfigCache
+class ConfigCache extends ResourceCheckerConfigCache
 {
     private $debug;
 
@@ -33,7 +39,10 @@ class ConfigCache extends ValidatorConfigCache
      */
     public function __construct($file, $debug)
     {
-        parent::__construct($file, array(new ResourceValidator()));
+        parent::__construct($file, array(
+            new DefaultResourceChecker(),
+            new BCResourceInterfaceChecker()
+        ));
         $this->debug = (bool) $debug;
     }
 

diff --git a/src/Symfony/Component/Config/ConfigCacheFactory.php b/src/Symfony/Component/Config/ConfigCacheFactory.php
@@ -11,12 +11,12 @@
 
 namespace Symfony\Component\Config;
 
-use Symfony\Component\Config\Resource\ResourceValidator;
-
 /**
- * Basic implementation of ConfigCacheFactoryInterface.
- * Creates a ConfigCache instance that will be validated with the
- * ResourceValidator only.
+ * Basic implementation of ConfigCacheFactoryInterface that
+ * creates an instance of the default ConfigCache.
+ *
+ * This factory and/or cache <em>do not</em> support cache validation
+ * by means of ResourceChecker instances (that is, service-based).
  *
  * @author Matthias Pigulla <mp@webfactory.de>
  */

diff --git a/src/Symfony/Component/Config/DependencyInjection/ConfigCachePass.php b/src/Symfony/Component/Config/DependencyInjection/ConfigCachePass.php
diff --git a/src/Symfony/Component/Config/Resource/BCResourceInterfaceChecker.php b/src/Symfony/Component/Config/Resource/BCResourceInterfaceChecker.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Resource;
+
+/**
+ * Resource checker for the ResourceInterface. Exists for BC.
+ *
+ * @author Matthias Pigulla <mp@webfactory.de>
+ *
+ * @deprecated since 2.8, to be removed in 3.0.
+ */
+class BCResourceInterfaceChecker extends DefaultResourceChecker
+{
+    public function supports(ResourceInterface $metadata)
+    {
+        /* As all resources must be instanceof ResourceInterface,
+           we support them all. */
+        return true;
+    }
+
+    public function isFresh(ResourceInterface $metadata, $timestamp)
+    {
+        trigger_error('Resource checking through ResourceInterface::isFresh() is deprecated since 2.8 and will be removed in 3.0', E_USER_DEPRECATED);
+
+        return parent::isFresh($metadata, $timestamp); // For now, $metadata features the isFresh() method, so off we go (quack quack)
+    }
+}
diff --git a/src/Symfony/Component/Config/Resource/DefaultResourceChecker.php b/src/Symfony/Component/Config/Resource/DefaultResourceChecker.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Resource;
+
+use Symfony\Component\Config\ResourceCheckerInterface;
+
+/**
+ * Resource checker for instances of
+ * SelfCheckingResourceInterface. As these resources can
+ * perform the check themselves, we can support them in a generic
+ * way.
+ *
+ * @author Matthias Pigulla <mp@webfactory.de>
+ */
+class DefaultResourceChecker implements ResourceCheckerInterface
+{
+    public function supports(ResourceInterface $metadata)
+    {
+        return $metadata instanceof SelfCheckingResourceInterface;
+    }
+
+    public function isFresh(ResourceInterface $metadata, $timestamp)
+    {
+        /** @var SelfCheckingResourceInterface $metadata */
+        return $metadata->isFresh($timestamp);
+    }
+}
diff --git a/src/Symfony/Component/Config/Resource/DirectoryResource.php b/src/Symfony/Component/Config/Resource/DirectoryResource.php
@@ -16,7 +16,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class DirectoryResource implements ResourceInterface, \Serializable
+class DirectoryResource implements SelfCheckingResourceInterface, \Serializable
 {
     private $resource;
     private $pattern;

diff --git a/src/Symfony/Component/Config/Resource/FileExistenceResource.php b/src/Symfony/Component/Config/Resource/FileExistenceResource.php
@@ -19,7 +19,7 @@
  *
  * @author Charles-Henri Bruyand <charleshenri.bruyand@gmail.com>
  */
-class FileExistenceResource implements ResourceInterface, \Serializable
+class FileExistenceResource implements SelfCheckingResourceInterface, \Serializable
 {
     private $resource;
 

diff --git a/src/Symfony/Component/Config/Resource/FileResource.php b/src/Symfony/Component/Config/Resource/FileResource.php
@@ -18,7 +18,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class FileResource implements ResourceInterface, \Serializable
+class FileResource implements SelfCheckingResourceInterface, \Serializable
 {
     /**
      * @var string|false

diff --git a/src/Symfony/Component/Config/Resource/ResourceInterface.php b/src/Symfony/Component/Config/Resource/ResourceInterface.php
@@ -37,6 +37,9 @@ public function __toString();
      * @param int $timestamp The last time the resource was loaded
      *
      * @return bool True if the resource has not been updated, false otherwise
+     *
+     * @deprecated since 2.8, to be removed in 3.0. If your resource can check itself for
+     *             freshness implement the SelfCheckingResourceInterface instead.
      */
     public function isFresh($timestamp);
 

diff --git a/src/Symfony/Component/Config/Resource/ResourceValidator.php b/src/Symfony/Component/Config/Resource/ResourceValidator.php