Moved cache configuration to compiler pass, so any expressions used in the metadata_cache_pool config setting can be resolved

Author: pmishev

.travis.yml

@@ -23,7 +23,7 @@ before_script:
   - export XDEBUG_MODE=coverage
 
 script:
-  - wget -q --waitretry=1 --retry-connrefused -T 30 -O - http://127.0.0.1:9200
+  - wget -nv --waitretry=1 --retry-connrefused -T 30 -O - http://127.0.0.1:9200
   - vendor/bin/simple-phpunit --coverage-clover=Tests/App/build/clover.xml 2>/dev/null
   - vendor/bin/phpcs -np --standard=PSR2 --ignore=vendor/,Tests/App/,var/ ./
 

DependencyInjection/Compiler/SetCachePass.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Sineflow\ElasticsearchBundle\DependencyInjection\Compiler;
+
+use Sineflow\ElasticsearchBundle\Mapping\DocumentMetadataCollector;
+use Symfony\Component\Cache\Adapter\NullAdapter;
+use Symfony\Component\DependencyInjection\ChildDefinition;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+class SetCachePass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $customCachePool = $container->resolveEnvPlaceholders($container->getParameter('sfes.cache_pool'), true);
+
+        if ($customCachePool) {
+            // Use the custom metadata cache pool, if one is defined
+            $cachePoolDefinition = new Reference($customCachePool);
+        } else {
+            if (!$container->getParameter('kernel.debug')) {
+                // Use a service extending cache.system when kernel.debug is false (typically in prod and stage)
+                $cachePoolDefinition = new ChildDefinition('cache.system');
+                $cachePoolDefinition->addTag('cache.pool');
+            } else {
+                // By default, don't use cache if kernel.debug is set (typically in dev and test)
+                $cachePoolDefinition = new Definition(NullAdapter::class);
+            }
+        }
+        $container->getDefinition(DocumentMetadataCollector::class)->setArgument('$cache', $cachePoolDefinition);
+    }
+}

DependencyInjection/SineflowElasticsearchExtension.php

@@ -4,12 +4,9 @@
 
 use Sineflow\ElasticsearchBundle\Document\Provider\ProviderInterface;
 use Sineflow\ElasticsearchBundle\Document\Repository\ServiceRepositoryInterface;
-use Sineflow\ElasticsearchBundle\Mapping\DocumentMetadataCollector;
 use Symfony\Component\Config\FileLocator;
-use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -43,6 +40,7 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('sfes.connections', $config['connections']);
         $container->setParameter('sfes.indices', $config['indices']);
         $container->setParameter('sfes.languages', $config['languages']);
+        $container->setParameter('sfes.cache_pool', $config['metadata_cache_pool'] ?? null);
 
         $container
             ->registerForAutoconfiguration(ServiceRepositoryInterface::class)
@@ -51,17 +49,5 @@ public function load(array $configs, ContainerBuilder $container)
         $container
             ->registerForAutoconfiguration(ProviderInterface::class)
             ->addTag('sfes.provider');
-
-        // Set cache pool
-        if (isset($config['metadata_cache_pool'])) {
-            // Use the configured metadata cache pool, if one is defined
-            $cachePoolDefinition = new Reference($config['metadata_cache_pool']);
-        } else {
-            // Use a service extending cache.system
-            $cachePoolDefinition = new ChildDefinition('cache.system');
-            $cachePoolDefinition->addTag('cache.pool');
-            $container->setDefinition('cache.sfes', $cachePoolDefinition);
-        }
-        $container->getDefinition(DocumentMetadataCollector::class)->setArgument('$cache', $cachePoolDefinition);
     }
 }

SineflowElasticsearchBundle.php

@@ -4,6 +4,7 @@
 
 use Sineflow\ElasticsearchBundle\DependencyInjection\Compiler\AddConnectionsPass;
 use Sineflow\ElasticsearchBundle\DependencyInjection\Compiler\AddIndexManagersPass;
+use Sineflow\ElasticsearchBundle\DependencyInjection\Compiler\SetCachePass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -21,5 +22,6 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new AddConnectionsPass());
         $container->addCompilerPass(new AddIndexManagersPass());
+        $container->addCompilerPass(new SetCachePass());
     }
 }