Make the always_expire_wfd_meta_resources config setting work regardless of kernel.debug mode (#50)

The `always_expire_wfd_meta_resources` config setting can be used to
make `WfdMetaResource` instances always expire immediately. It is
supposed to be set in Symfony environments like `test` (e. g. in a
`config_test.yml` file or a `when@test` section).

However, until now, it works correctly only for `kernel.debug = true`. 

This is because it used a special `CacheBustingResourceChecker` that
would be used by the "inner" (regular) `ConfigCache` instance only. That
ResourceChecker would invalidate the cache when an instance of a
`WfdMetaResource` is found.

The `ConfigCache`, however, contains a shortcut to never validate the
cache in the first place when `kernel.debug` is disabled.

Thus, we need to move this behavior to the `WfdMetaConfigCache`, which
will run its check also in non-debug mode. There, we want to consider
the setting only in the case that there are actually `WfdMetaResource`s
associated with the cache in question.

Being able to disable `kernel.debug` mode for tests execution can
provide a significant speed-up in environments where you don't actually
modify code between test runs, i. e. a CI pipeline.

Author: mpdude

src/Config/CacheBustingResourceChecker.php

@@ -23,11 +23,14 @@ class WfdMetaConfigCache implements ConfigCacheInterface
     /** @var ConfigCacheInterface */
     private $innerCache;
 
-    public function __construct($file, ConfigCacheInterface $innerCache, MetaQueryFactory $metaQueryFactory)
+    private bool $forceExpiration;
+
+    public function __construct($file, ConfigCacheInterface $innerCache, MetaQueryFactory $metaQueryFactory, bool $forceExpiration = false)
     {
         $this->file = $file;
         $this->innerCache = $innerCache;
         $this->metaQueryFactory = $metaQueryFactory;
+        $this->forceExpiration = $forceExpiration;
     }
 
     public function getPath(): string
@@ -62,6 +65,10 @@ public function isWfdMetaFresh(): bool
             return true;
         }
 
+        if ($this->forceExpiration) {
+            return false;
+        }
+
         $metaQuery = $this->metaQueryFactory->create();
 
         foreach ($wfdMetaResources['resources'] as $wfdMetaResource) {

src/Config/WfdMetaConfigCache.php

@@ -34,11 +34,19 @@ class WfdMetaConfigCacheFactory implements ConfigCacheFactoryInterface
      */
     private $lockFactory;
 
-    public function __construct(ConfigCacheFactoryInterface $configCacheFactory, MetaQueryFactory $metaQueryFactory, LockFactory $lockFactory)
+    private bool $expireWfdMetaResources;
+
+    public function __construct(ConfigCacheFactoryInterface $configCacheFactory, MetaQueryFactory $metaQueryFactory, LockFactory $lockFactory, bool $expireWfdMetaResources = false)
     {
         $this->configCacheFactory = $configCacheFactory;
         $this->metaQueryFactory = $metaQueryFactory;
         $this->lockFactory = $lockFactory;
+        $this->expireWfdMetaResources = $expireWfdMetaResources;
+    }
+
+    public function expireWfdMetaResources(): void
+    {
+        $this->expireWfdMetaResources = true;
     }
 
     public function cache($file, $callback): ConfigCacheInterface
@@ -70,7 +78,7 @@ public function cache($file, $callback): ConfigCacheInterface
 
     private function createCache($file, ConfigCacheInterface $innerCache): ConfigCacheInterface
     {
-        return new WfdMetaConfigCache($file, $innerCache, $this->metaQueryFactory);
+        return new WfdMetaConfigCache($file, $innerCache, $this->metaQueryFactory, $this->expireWfdMetaResources);
     }
 
     private function fillCache($callback, ConfigCacheInterface $cache): void

src/Config/WfdMetaConfigCacheFactory.php

@@ -33,8 +33,6 @@ public function load(array $configs, ContainerBuilder $container): void
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-        if ($config['always_expire_wfd_meta_resources']) {
-            $yamlLoader->load('cache_busting.yml');
-        }
+        $container->setParameter('webfactory_wfd_meta.expire_wfd_meta_resources', $config['always_expire_wfd_meta_resources']);
     }
 }

src/DependencyInjection/WebfactoryWfdMetaExtension.php

@@ -50,6 +50,7 @@
                     <tag name="monolog.logger" channel="webfactory_wfd_meta" />
                 </service>
             </argument>
+            <argument>%webfactory_wfd_meta.expire_wfd_meta_resources%</argument>
         </service>
     </services>
 </container>